I've worked on docs at quite a few companies at this point. Almost every company I've ever seen has built a Rube Goldberg machine and totally overengineered their docs for reasons I simply can't understand. It's funniest when the overengineering doesn't even solve problems better than the vanilla solutions out there like AsciiDoctor and Sphinx. So many useless checks. So much unmaintainable javascript and styling. So many botched search and AI chat implementations. And don't even get me started on Vale, which generally just annoys the hell out of contributors instead of helping them.
Great work on the site, Tangled. Your docs site contains useful instructions and a sidebar that clearly communicates an organization structure. It doesn't peg my CPU or RAM. It's amazing how that makes your site better than 90% of docs sites out there.
One tip: could you add a favicon? Bonus points if it's slightly distinct from your main site's favicon so I can distinguish docs tabs at a glance.
>Tangled is a decentralized Git hosting and collaboration platform.
it is _not_ about Literate Programming (which is what I was expecting).
A previous active discussion of this project:
note that the mkdocs-material folks are now working on https://zensical.org/ which is in rust and _much_ faster. it solves this specific requirement by autogenerating the navigation based on file structure.
it's still early / under active development, but i recently rebuilt our techdocs on top of it. a simple github workflow to aggregate from our two monorepos + some bash-fu to merge them together and voila! no config file headaches
I run a documentation product, ReadMe. There's a lot of reasons to roll your own, but I'd recommend you also look into a third-party tool like us. One of the biggest reasons to use a product is that the building v1 is easy, but keeping it up to date over time is a lot tougher... you're stuck remembering how to deploy, figuring out a workflow, dealing with multiple versions, etc.
You also just don't get a ton of really great features for your developers... fast typeahead search, AI tools (which your developers increasingly really want), navigation, accessibility and more. ReadMe also lets your developers play around with you API locally and get copy-and-paste code snippets.
(If you're deciding between your own and ReadMe, email me! greg@readme.io; would love to talk)
It's just a worse developer experience. Fine if you aren't a serious business, but yeah I wouldn't play down the value of Mintlify or similar products. It's seriously good and it's why huge companies use it