On openHAB documentation and some more

I think this might be far more easily achieved through the Sitemap / Basic UI route. We just need some different “Templates” / “Skins” to choose from.

I tried to restructure and simplify some docs, starting with blockly, but faced a lot of challenges from the existing doc maintainers that made me give up. My impression is that:

  • The status quo is sacred and the current documentation cannot be changed. Heaven forbid we removed a paragraph from the current doc. In other words, there’s a high resistance to change.
  • Only new additions are welcomed
  • As a result, things just keep getting more and more complex, longer and wordier.
  • Which makes the doc an onerous chore to read by (new) users, especially those who don’t enjoy reading super long novels.
  • We basically need a TL;DR version but I understand that it’s not easy

This is the part that really needs a major restructure of the docs, a MAJOR demolition and rebuild. But who would take on such a task if it would just get rejected anyway? This will take hours and hours of work and the risk of rejection is high based on my experience.

3 Likes