You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When making improvement to the source code, you always need to update the documentation accordingly.
Today, the doc is in a wiki which is part of a separate repository.
It would be nice to host the docs directly in a /docs/ folder so the documentation change can be part of the PR and commit history.
This will also enable easy integration with other tools like mkdocs and readthedocs and continuous build using github actions
Hi,
When making improvement to the source code, you always need to update the documentation accordingly.
Today, the doc is in a wiki which is part of a separate repository.
It would be nice to host the docs directly in a
/docs/
folder so the documentation change can be part of the PR and commit history.This will also enable easy integration with other tools like mkdocs and readthedocs and continuous build using github actions
See Continuous Documentation: Hosting Read the Docs on GitHub Pages
You can still edit and preview .md files from github web interface like the wiki
What do you think?
The text was updated successfully, but these errors were encountered: