Refresh stale end-user and build documentation - #1022
Conversation
There was a problem hiding this comment.
If possible, you could move all build docs to docs/building.rst (and also EMSCRIPTEN.md -> docs/emscripten.rst) instead and remove the Markdown files in the main dir. Since the generated Doxygen output isn't available anywhere yet, linking to the RST files in the main README.md should suffice.
This will keep only one instance of the docs, making it easier to update and reducing the chance of diverging from development.
GitHub renders RST fine (and it's also quite readable as-is), so for users visiting the repository, there shouldn't be much of a difference.
Done |
3b11631 to
bc78b7f
Compare
Brings the user-facing docs in line with the current state of the project. No code changes.
End-user downloads (README.md, docs/index.rst):
Build docs (BUILDING.md, BUILDING-cmake.md):
Sphinx docs (docs/):