Developers

Maintaining the documentation

Keep pages aligned with the product and validate the documentation site.

The documentation is separate from the product repository. It must not infer feature state from the landing page or demo.

Priority sources

  1. Code and tests in projets/tradoc.
  2. Current output of --help commands.
  3. .env.example, Dockerfile and Compose files.
  4. Product interface.
  5. README, after verification against the code.

Validation

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

When the product changes

  • New provider: update providers and connection tests.
  • New format: document extraction, preview, reconstruction and MIME type.
  • New variable: add default, limits and security implications.
  • New command: run --help before publishing its syntax.
  • New domain: present it as active only after a real HTTPS check.

Four-language ownership

English is canonical. Every English page must have complete French, Spanish and German counterparts before publication. A product change that affects documentation updates all four files in the same pull request; no locale may silently fall back to English or be labeled as translated while stale.

Markdown for assistants

Every page exposes processed Markdown through the page menu. It is generated from the same localized MDX so a second, divergent documentation set cannot appear.