Reference
Reference pages define stable contracts. They are not tutorials. Use them when you already know what you want to do and need the exact command, schema, artifact rule, or validation behavior.
Reference Index
| Page | Use it for |
|---|---|
| CLI Reference | Canonical gridalyn commands and command groups. |
| Python API Reference | Auto-generated docstring reference for the seven layer facades. |
| Public API Index | Curated index of every supported import, by layer. |
| Workflow YAML | workflow.yaml stage and dependency conventions. project.yaml's own contract is documented narratively in Projects and Project Template, since its fields vary by study. |
| Report Schemas | Canonical JSON report structure and metadata. |
| Semantic Model And Graph | Node/edge schema, ontology profile, query API, and graph artifacts. |
| Standards Alignment | Verified identifiers, versions and term spellings of the standards the semantic profile names, and where the profile disagrees. |
| FalkorDB Path | What exists today (a Cypher-export helper) versus what a live FalkorDB connection would require (not implemented). |
| Artifact Policy | What can be committed, generated, ignored, or published. |
| Glossary | One-line definitions of the terms the rest of the site uses without redefining. |
| Testing And Validation | Project verification ladder and repository checks. |
Contract Style
Reference pages should answer:
- what the contract is called;
- which file, command, or API owns it;
- which inputs are required;
- which outputs are produced;
- how to validate it;
- what should remain stable for users.
Explanatory background belongs in Components. Step-by-step instructions belong in Start or Guides.