gbans
gbans copied to clipboard
Create Proper User Facing Documentation
Getting closer to needing some real docs for people to use. A lot of the configuration and setup is not documented at all or somewhat outdated.
Prefer markdown, but rst is ok. Needs to be capable of being rebuilt / deployed on push
Static site generators are likely the best choice. There is a few options at:
- https://www.gitbook.com/
- https://about.readthedocs.com/ (basically a sphinx theme?)
- https://github.com/mkdocs/mkdocs/tree/master
- https://github.com/sphinx-doc/sphinx
- https://vitepress.dev/