Technical documentation for the documentation directory structure and organization.
README.md: Documentation hub and navigationindex.md: Main documentation indexdocumentation-index.md: Flat index of every long-lived pagegate.md: start-gate arms, CI job mapping, local-run policygnn_conformance.md: GNN pin file, .github/GNN.md pointer, and jobgetting_started.md: Quick start guideenvironment.md: Environment setup and configurationpipeline.md: System architecture and pipeline overviewmethods.md: Methods and evidence protocolmanuscript.md: Manuscript-facing engineering noteoperations.md: Operations and release evidenceconfiguration.md: Configuration referencedata_outputs.md: Data outputs documentationvisualizations.md: Visualization documentationtranslations.md: Translation documentationdocs_and_deployment.md: Documentation deployment guideTESTING.md: Testing policies and workflowsCONTRIBUTING.md: Contribution guidelinesconventions.md: Code and documentation conventionsFAQ.md: Frequently asked questionsROADMAP.md: Historical roadmap pointer; the canonical forward backlog is
the root TODO.mdexamples.md: Examples and usage patternsclones.md: Repository clone managementlearning_api_integration.md: API integration guidelearning_usage_guide.md: Usage guidecurriculum_gui.md: Browser-based curriculum generator GUIother/: Additional documentation resources_generated/: Script-written documents; gate-timings.md comes from
uv run start-gate measure and is verified by uv run start-gate numbersDocumentation is built using MkDocs:
mkdocs.yml (root)run_docs.sh (root)site/ directory (generated)Documentation follows hierarchical structure: