Workflows

2026-03-31

This repository follows the DIRAC documentation workflow used by other MkDocs-template-compliant repos in the workspace.

Canonical ADR Workflow

1. Draft or revise architecture background in a working note.
2. Promote stable platform decisions into docs/adr/canonical/.
3. Reference the canonical ADR from repo-local overrides in owning repositories.
4. Keep architecture pages descriptive and move normative decisions into ADRs.

Documentation Editing Workflow

1. Update the root entry pages in docs/ when navigation or repo intent changes.
2. Keep English documentation in the root docs/ tree.
3. Run mkdocs build after each structural change to validate navigation, hooks, and generated registry output.

Compliance Rules

• Root-level pages in docs/ provide the template-compliant navigation entrypoints.
• Localized placeholder builds are excluded in development mode.
• Editorial metadata is refreshed by the build hook instead of manual edits.
• Semantic discovery output is generated at build time from the published docs set.