The github repo is at https://github.com/openhab/openhab-docs.
The PR for the Getting Started tutorial for OH 3 is at https://github.com/openhab/openhab-docs/pull/1304.
At the bottom of every page in the docs is a "Caught a mistake or want to contribute to the documentation? Edit this page on GitHub " link.
You can open an issue if you think the changes need to be more drastic or needs further input from the maintainers. Please don’t spend time making massive edits to the docs without opening an issue and describing what you want to contribute. There might already be something in work that you might bump up against.
There is an issue open to address migrating the docs to OH 3 at https://github.com/openhab/openhab-docs/issues/1310.
If you want to propose something completely new for the docs often a good approach is to create a thread and request it be made into a wiki to get people who are members of the community here to help contribute to it. Then the result can be moved to the docs when it’s ready.
That overview is supposed to be provided by the Concepts section of the docs. The OH 3 Getting Started tutorial states up front that that part of the docs is a prerequisite to reading the tutorial.
If you are willing to help, thank you immensely! Far too often all we get is “your docs suck!”, “what in particular can we do to make it better?” we ask and the answer is “that’s not my job. I don’t have time!”
If they find something unclear or incorrect or missing they can tell us:
- “this section was unclear”
- “I don’t understand this”
- “But it doesn’t say how to do X”
But we never even get that much. Its always “your docs suck.” Nothing remotely actionable.
But in truth, you don’t have to know a lick about software to write most of these docs. The lead maintainer of the docs repo isn’t a developer. I don’t know anything about OH’s core code.
In that case you problably wouldn’t because that’s not really an openHAB problem. That’s a problem with the software being used to write to the SD card. We can’t write fully fledged documentation for everything that remotely touches openHAB. We can barely manage to keep up with what’s actually part of openHAB itself. And apparently we suck at that anyway so would you really want us to cover all that when what ever software you are using to write the SD card has their own docs and forum?
That would be best. The docs for OH 2.5 are probably not going to change much. The new Getting Started tutorial I’m migrating to the docs right now starts at [wiki] Getting Started with OH3: rewriting the tutorial - 1. Introduction. I’ve marked which ones I’ve moved to GitHub already so if you have suggestions for edits to those please add a comment on the github issue.