As an integration developer I'd like to have an easy to access and browsable API documentation.
As an API developer I'd like to have a simple documentation tool, preferrably in Markdown, with diagram embedding support and not have to learn yet another documentation format or deal with html & css layouting.
The current solution with simple markdown files in this GitHub repository is not very end-user friendly. It's very simple for API developers to add things, but it's getting more complicated to group content and adding an easy navigation.
Research better documentation website generators and evaluate which tool to use. Requirements:
easy to use for writing technical documentation, tailored to developers
must support Markdown files as input
GitHub integration, automated publishing with changed or added input documents
As an integration developer I'd like to have an easy to access and browsable API documentation. As an API developer I'd like to have a simple documentation tool, preferrably in Markdown, with diagram embedding support and not have to learn yet another documentation format or deal with html & css layouting.
The current solution with simple markdown files in this GitHub repository is not very end-user friendly. It's very simple for API developers to add things, but it's getting more complicated to group content and adding an easy navigation.
Research better documentation website generators and evaluate which tool to use. Requirements:
At the moment we are aware of the following solutions:
Reddit discussion with lots of options: https://www.reddit.com/r/selfhosted/comments/kphfbl/is_there_a_self_hosted_gitbook_alternative/