4 ms·
We agree - useful, accurate, and up to date docs are what increases trust! We're bringing docs closer to the diagrams to visually explain your system in smaller
by JacobDesigns 5y ago
We agree - useful, accurate, and up to date docs are what increases trust! We're bringing docs closer to the diagrams to visually explain your system in smaller chunks. We've found docs often accompany diagrams, and they become out of date as soon as they're exported! We think instead of diagrams being in docs, docs should be in the diagram.
- jmarcher 5y agoAlternatively, they can live together. For example, I ended up writing this to integrate diagrams and Sphinx. https://github.com/j-martin/sphinx-diagrams https://github.com/j-martin/sphinx-diagrams Similarly there's https://pypi.org/project/sphinxcontrib-plantuml/ https://pypi.org/project/sphinxcontrib-plantuml/ and https://mermaid-js.github.io/mermaid/#/ https://mermaid-js.github.io/mermaid/#/ (among other similar tools).