Documentation that ships with the code

Par Studio LXD

Plataforma
Cette page n'est pas encore traduite : vous lisez la version anglaise.

Docs drift when they live somewhere else

A separate documentation repository is a promise to update two places. The second one loses. The result is documentation that is confidently wrong, which is worse than documentation that is missing.

Where the docs live

Each product carries its own src/content/docs/ folder inside its own app. The pull request that changes a feature changes its documentation in the same commit — that is the only mechanism that actually keeps docs honest.

This site reads all of those folders at build time and publishes them under one roof, with one search index over every product plus the platform.

Empty sections are on purpose

Some products arrive with little or no documentation. Those sections show up empty rather than hidden: a visible gap is a reminder, and hiding it would only make the suite look more finished than it is.

Retour au blog