Skip to content

Conversation

@SirUli
Copy link

@SirUli SirUli commented Aug 28, 2025

  • Corrected markdown structures
  • German spellchecking

It looks worse than it actually is ;-)

Copy link
Contributor

@shining-man shining-man left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quite a lot of changes 🙂 I’ve gone through everything, left some comments, and there are a few things (e.g. with the lists) that I didn’t fully understand — could you take a look?

- Corrected markdown structures
- German spellchecking
@SirUli
Copy link
Author

SirUli commented Aug 31, 2025

Hi @shining-man Thanks for your review and patience with this. Sorry for some of the hiccups - that was totally unintended.

To come back to your feedback:

  • I re-established the new lines i accidentally removed (in all files)
  • I fixed the lists globally (e.g. in hardware.md or in settings_inverter.md actually the indentation for the different hardware revisions is currently wrong) after your comment that these need to be four spaces. Thanks indeed i missed that python-markdown does that for mkdocs. other markdown renderer libraries actually enforce two.
  • As commented, i'm indeed didn't see the multiple new lines as consistent throughout and therefore removed them where i found them. I re-established the ones that were previously there.

Generally i would advise to use something like pre-commit with a config for markdownlint (including fix) and to establish a common markdownlint config (or any other tool to enforce standards for these docs. My proposal for a .markdownlint.yaml would be:

# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
MD007:
  # Spaces for indent
  indent: 4
  # Whether to indent the first level of the list
  start_indented: false
  # Spaces for first level indent (when start_indented is set)
  start_indent: 2

# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
MD012:
  # Consecutive blank lines
  maximum: 2

# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
MD013: false
MD024: false
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
MD033: false
MD036: false
MD041: false
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants