Skip to content

Publishing

OIR publishes through MkDocs Material. The generated website is written to generated/site/ and should not be manually edited.

Local Preview

Run:

.\.venv\Scripts\mkdocs serve --dev-addr 127.0.0.1:8000

Then open http://127.0.0.1:8000.

Validation

Publishing checks include:

  • Metadata graph validation
  • Local Markdown link validation
  • Bibliography and glossary index generation
  • Strict MkDocs build

The same checks run in GitHub Actions.

Generated Indexes

The current prototype generator writes: