3 ms·
Agreed with your point of accessibility to people who don't live in the code. But that doesn't preculude documentation near code nor Markdown. It just means th
by mfuzzey 2y ago
Agreed with your point of accessibility to people who don't live in the code.
But that doesn't preculude documentation near code nor Markdown. It just means that you need a CI job to publish the doc stored in the git repo as (for example) HTML or PDF.
For diagrams stuff like PlantUML are great, edit as text, publish as images.
- jeffreygoesto 2y agoCan confirm. We are using Sphinx(-Needs actually) and I can send deeplinks to develop, release or feature branch rendered docs to everyone, including non technical staff. You just have to know the "latest of develop" or release links always work, the branch ones are for quick and ephemeral communication only. We include PlantUML and drawio as source along with the code and PR reviews check that code and doc update in sync.