Operations

2026-03-31

Local Development

Install the documentation dependencies and serve the site locally:

pip install -r requirements.txt
mkdocs serve

Validation

Use a local build as the baseline compliance check:

mkdocs build

The build should:

• load the local hooks from hooks/
• refresh extra.oves_revision_date
• generate site/assets/semantic-doc-registry.json
• exclude docs/fr/ and docs/zh/ from the development build nav

Publishing Notes

• Keep site_url, repo_name, and repo_url aligned with the GitHub repo.
• Maintain OVES metadata in mkdocs.yml.
• Add translated root pages only when release-ready multilingual publishing is requested.