Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown Documentation fixes #17526

Merged
merged 14 commits into from
Oct 10, 2024
Merged

Conversation

lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Oct 8, 2024

  • removed colon in paragraph headers
  • corrected wrong spelling of openHAB
  • removed excess line feeds
  • add some missing code fence languages
  • ... while doing so i fixed some other markdown warnings while i had the files open

Signed-off-by: Leo Siepel <[email protected]>
Signed-off-by: Leo Siepel <[email protected]>
Copy link
Contributor

@psmedley psmedley left a comment

Choose a reason for hiding this comment

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

Approved for my bindings

@marcelrv
Copy link
Contributor

marcelrv commented Oct 9, 2024

For miio, the documentation is automatically generated. Hence direct changes of the readme will be overwritted with each update.
To make the change persist the code of the readme helper needs to be adjusted.
https://github.com/openhab/openhab-addons/blob/main/bundles/org.openhab.binding.miio/src/test/java/org/openhab/binding/miio/internal/ReadmeHelper.java

Signed-off-by: Leo Siepel <[email protected]>
@lsiepel
Copy link
Contributor Author

lsiepel commented Oct 9, 2024

For miio, the documentation is automatically generated. Hence direct changes of the readme will be overwritted with each update. To make the change persist the code of the readme helper needs to be adjusted. https://github.com/openhab/openhab-addons/blob/main/bundles/org.openhab.binding.miio/src/test/java/org/openhab/binding/miio/internal/ReadmeHelper.java

Thanks, done!

Signed-off-by: Leo Siepel <[email protected]>
Signed-off-by: Leo Siepel <[email protected]>
Copy link
Member

@wborn wborn left a comment

Choose a reason for hiding this comment

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

Thanks for the huge cleanup! 👍
Can you also fix the merge conflict?

Copy link
Contributor

@goopilot goopilot left a comment

Choose a reason for hiding this comment

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

lgtm for folderwatcher binding

@wborn wborn merged commit 20b889c into openhab:main Oct 10, 2024
5 checks passed
@wborn wborn added this to the 4.3 milestone Oct 10, 2024
@lsiepel lsiepel deleted the documentation-multiple branch October 10, 2024 21:25
joni1993 pushed a commit to joni1993/openhab-addons that referenced this pull request Oct 15, 2024
matchews pushed a commit to matchews/openhab-addons that referenced this pull request Oct 18, 2024
cipianpascu pushed a commit to cipianpascu/openhab-addons that referenced this pull request Jan 2, 2025
Signed-off-by: Leo Siepel <[email protected]>
Signed-off-by: Ciprian Pascu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.