phoenix documentation tools
We need
-
tools that we can use to write User, Developers and API reference documentation, all integrated together, to make the documentation of each phoenix projects. Potential tools:
- User and Developers documentation: Text, diagrams, images
- latex compiler
- mkdoc + material theme + mermaid for diagrams
- API reference: generated from docstring
- User and Developers documentation: Text, diagrams, images
-
tool to generate library level documentation: aggregation of all phoenix package documentation and documentation of dependencies between packages. Potential tools:
- docusaurus
- mkdoc with pages been links to packages documentation
-
test the different tools to find better combination
Edited by Thibaut Oprinsen