Having documentation in Markdown files *in* the repository alongside the code, instead of on a CMS or wiki, can be great:
- It pops up in code searches.
- It can be kept up-to-date while refactoring.
- It is wherever the code is (text editor, Git UI, tarball download)
@krinkle Also, have a job in the CI pipeline to recompile and redeploy the documentation site.
@krinkle Even better when you can run tests on the examples in your documentation, like you can with Sphinx.
The social network of the future: No ads, no corporate surveillance, ethical design, and decentralization! Own your data with Mastodon!