Focus on your documentation.
Spend your time on writing high quality documentation, not on the tools to make your documentation work.
For open source, and now for your business.
Write documentation alongside your code, with all your same tools. You can write with reStructuredText or Markdown.
Using webhooks, your documentation is automatically kept up to date, across all versions of your software.
How it works
- Write documentation
- Documentation can be written in reStructuredText or Markdown. Write just prose documentation, or include referential documentation that is written alongside your code.
- Keep it up to date
- Your documentation is always next to your source code, so you always have a clear path to update your documentation when you make changes to your code. No more external tools for editing documentation, which your developers will love.
- Value your docs
- All too often, when documentation is lacking, the act of writing or maintaining documentation becomes under-valued, which only worsens the state of the information. Having tools that work means lowering the bar to submitting documentation, which means your docs will actually get written.
- Read the docs
- Your documentation can be available privately or publicly. Access is limited by users and teams to privately hosted projects. Publicly hosted documentation allows your company to intergrate your documentation with your existing site, allowing your customers to use your documentation.