Documentation Index
MIF ontology corpus, documentation
Section titled “MIF ontology corpus, documentation”Documentation for the modeled-information-format/ontologies corpus, organized by
Diátaxis type. The first four sections cover the ontologies
themselves; the last two cover the attested release pipeline that ships them.
Tutorial
Section titled “Tutorial”Learning-oriented. Start here if you are new to authoring ontologies.
| Tutorial | Summary |
|---|---|
| Author your first ontology | Write a small domain ontology by hand that extends mif-base and shared-traits, declares a namespace, and composes inherited traits into one entity type |
How-to guides
Section titled “How-to guides”Task-oriented. Follow these to accomplish a specific goal.
| Guide | Summary |
|---|---|
| Add a domain ontology | Add a new flat ontologies/<name>.ontology.yaml, generate its JSON-LD projection, and validate it |
| Submit an ontology | The end-to-end contribution path: branch, author, validate, open a PR, pass the gates, and release |
| Instantiate with Copier | Stand up a new project from the underlying template and pull future improvements with copier update |
Reference
Section titled “Reference”Information-oriented. Consult these for exact facts.
| Reference | Summary |
|---|---|
| Ontology corpus reference | The full catalog of ontologies, the namespace triad, the trait catalog, the ontology file schema, and conformance rules |
| Quality gates and workflows | Every workflow (ci.yml, quality-gates.yml, release.yml, dast.yml): jobs, triggers, predicate types, and verification commands |
Explanation
Section titled “Explanation”Understanding-oriented. Read these for the reasoning behind the design.
| Explanation | Summary |
|---|---|
| The ontology model | Why the corpus is shared and central, how one model is read by a person and a parser, and the reasoning behind the triad, trait composition, and underscore-prefixed base namespaces |
| The attested pipeline model | The build, attest, verify, publish invariant and why publication is fail-closed |
Runbooks
Section titled “Runbooks”Operational procedures for maintainers.
| Runbook | Summary |
|---|---|
| Release the corpus | Cut a versioned, attested release by pushing a SemVer tag through the pipeline |
| CI or release gate failure | Diagnose and clear a red security gate on a pull request or release tag |
Decisions
Section titled “Decisions”| ADR | Summary |
|---|---|
| ADR 0001: underscore-prefixed base namespaces | Why _semantic, _episodic, and _procedural carry a leading underscore |
For consumer-facing verification instructions see SECURITY.md.
For the org-wide attestation architecture and ecosystem concepts see the
modeled-information-format docs.