Reference

Reference

The exhaustive, mechanical listings : every endpoint, every MCP tool, every permission, every lifecycle step, every environment variable. Look things up here; understand them in the specifications or the technical documentation.

Hand-written

Page	Contents
REST API	Base paths, authentication, conventions, the error contract, module-specific rules
MCP server	Transport, OAuth 2.0, the protocol, the CRUD pattern

Generated pages

Everything below is rendered from the code by python manage.py generate_docs, and CI fails when one is stale. Do not edit them : each carries a do-not-edit banner naming its source, and an edit is reverted by the next run. Change the code and regenerate.

Page	Rendered from
REST endpoints	Django's URL resolver
MCP tools	The MCP tool registry
Permissions	PERMISSION_REGISTRY and SYSTEM_GROUPS
Lifecycles	The lifecycle registry
Dashboard widgets	DASHBOARD_WIDGETS
Models	The Django model registry
Environment variables	The settings modules, cross-checked against .env.example
Management commands	The management-command registry

Per-module MCP parameter tables live alongside the index : context, assets, compliance, risks, incidents, reports, trust center, system, general.

Why these are generated

A reference is the part of documentation most likely to drift and least likely to be noticed drifting, because nobody reads it end to end : they look up one row and trust it. Deriving these pages from the registries the application itself reads means they cannot describe a permission that does not exist or miss an endpoint that does.

The mechanism is described in technical/documentation.md.