Documentation is an essential part of openHAB, but keeping it consistent and error-free has been a recurring challenge. Currently, small markup errors are easily introduced, and historically we’ve had to create bulk PRs to fix these ad hoc.
To address this sustainably, I propose to:
-
Add a markup validation step to the build process.
This will automatically catch common syntax and formatting issues during PR reviews.
-
Ensure all current documentation passes the validation
As a prerequisite, I’ll create additional PR`s that correct existing issues across the bindings.
Once in place, the markup check will help maintain the quality of our documentation, reduce the need for future bulk fixes, and make contributions smoother for everyone.
I’ll use this issue to track the related PRs and progress. Feedback and suggestions are welcome!
And some catchup PR's
The first PR that enables the Github action can be merged at any time. It will fail as long as the other PR's have not yet been merged.
Documentation is an essential part of openHAB, but keeping it consistent and error-free has been a recurring challenge. Currently, small markup errors are easily introduced, and historically we’ve had to create bulk PRs to fix these ad hoc.
To address this sustainably, I propose to:
Add a markup validation step to the build process.
This will automatically catch common syntax and formatting issues during PR reviews.
Ensure all current documentation passes the validation
As a prerequisite, I’ll create additional PR`s that correct existing issues across the bindings.
Once in place, the markup check will help maintain the quality of our documentation, reduce the need for future bulk fixes, and make contributions smoother for everyone.
I’ll use this issue to track the related PRs and progress. Feedback and suggestions are welcome!
And some catchup PR's
The first PR that enables the Github action can be merged at any time. It will fail as long as the other PR's have not yet been merged.