Nots.io is a SaaS for engineering teams aimed to help keep project docs up-to-date by linking them to the source code.
Often times company’s docs and internal knowledge pile up in some knowledge base, wiki, google docs or simply in md files in the repo. And after a while, everything turns into a mess. It’s hard to find the right document, determine whether it actually covers the code developers are working on right now. When you find something, it’s tedious to detect if the document is not outdated and everybody can trust it.
With Nots.io it’s possible to link any type of doc directly with the code. Make a short note or full-blown markdown spec right at the site. Choose image, PDF, GoogleDoc file. Import description and discussion from GitHub pull request. Get links from jira issue numbers. We know that docs could be spread across many places. Now select several lines of code, whole file, commit or branch and link the doc you have with the code. Now all docs have a clear scope. It’s easy to discover what is documented right from the IDE or from our site.
We also track the relevance of each added document. When the code behind the doc changes, we decrease its relevance factor (we call it the fresh-rate). This answers whether the doc is fresh today, and you may rely on it. All this keeps the documentation up-to-date.
Based on our record, Slate API Docs Generator seems to be more popular. It has been mentiond 13 times since March 2021. We are tracking product recommendations and mentions on various public social media platforms and blogs. They can help you identify which product is more popular and what people think of it.
Https://github.com/slatedocs/slate this ! Big company use it ( stripe etc ). Source: over 1 year ago
The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." - so then Slate gets brought up as a suitable replacement. Source: about 2 years ago
DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.. - Source: dev.to / about 2 years ago
I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code. Source: about 2 years ago
We used to use Slate - https://github.com/slatedocs/slate for our APIs in my previous job. That was pretty neat. - Source: Hacker News / over 2 years ago
Doxygen - Generate documentation from source code
DocBook - DocBook is a schema (available in several languages including RELAX NG, SGML and XML DTDs, and W3C...
Docusaurus - Easy to maintain open source documentation websites
Text::Amuse - Markup language for AMuseWiki.
Compodoc - The missing documentation tool for your Angular application
Groff - The groff (GNU troff) software is a typesetting package which reads plain text mixed with...