We recently organized our documentation and put it up on https://docs.tangled.org, using just pandoc. For several reasons, using pandoc to roll your own static sites is more than sufficient for small projects.
requirements
Lives in our monorepo.
No JS: a collection of pages containing just text should not require JS to view!
Searchability: in practice, documentation engines that come bundled with a search-engine have always been lack lustre. I tend to Ctrl+F or use an actual search engine in most scenarios.
Low complexity: building, testing, deploying should be easy.
Easy to style
evaluating the ecosystem
I took the time to evaluate several documentation engine solutions:
Mintlify: It is quite obvious from their homepage that mintlify is performing an AI pivot for the sake of doing so.
... continue reading