Effective Date: 2024-10-27 Status: Active
This document establishes the canonical hierarchy of documentation, defines the “Frozen” state for core components, and mandates the protocols for modifying specifications and implementation.
The T81 documentation ecosystem is stratified by authority. In the event of a contradiction, the higher-authority source prevails.
| Level | Path | Content Type | Authority |
|---|---|---|---|
| 1 | /spec/** |
Normative Specs | Absolute. Defines the “law” of the system. |
| 2 | /docs/architecture/OVERVIEW.md |
Architecture | High. Defines system boundaries and invariants. |
| 3 | /docs/** |
Descriptive Docs | Medium. Explains the specs and architecture. |
| 4 | /docs/developer-guide/book/** |
Narrative | Low. Educational and illustrative. |
| 5 | /notebooks/**, /examples/** |
Experimental | None. Use at your own risk. |
| N/A | /artifacts/**, /benchmarks/results/** |
Generated | None. Ephemeral outputs. |
/docs conflicts with /spec, the /spec definition is correct. The documentation must be updated to match the spec.README.md conflicts with /docs/architecture/OVERVIEW.md, the OVERVIEW.md is correct./book directory is a monograph and may lag behind the bleeding edge. If it conflicts with /docs or /spec, the /docs or /spec prevails.src/ behaves differently than defined in /spec/, it is a bug in the code, unless the spec is explicitly marked as “Draft”. See docs/governance/SPEC_DRIFT_POLICY.md for enforcement details.Freeze boundaries are defined exclusively in FREEZE_ENFORCEMENT.md and itemized in the Deterministic Core Profile.
docs/governance/FREEZE_ENFORCEMENT.mdspec/supplemental/deterministic-core-profile-v1.mdspec/rfcs/RFC-0048-deterministic-surface-definition-and-governance-boundaries.mddocs/governance/DETERMINISM_SURFACE_REGISTRY.mdChanges to “Frozen” subsystems (as defined in the Core Profile) are restricted to preserve stability and determinism.
Determinism surface classification follows RFC-0048, which defines four exclusive surface classes:
RFC-0048 is the normative source of truth for surface classification. If a governance doc, README, or status page applies a classification inconsistent with the RFC-0048 taxonomy, the RFC-0048 definition prevails (per Authority Level 1 above).
All changes must adhere to the following protocols based on their nature.
/spec/.src/.tests/.docs/migration/./notebooks/, /examples/, or src/experimental/.Architecture and governance decisions with boundary impact must be recorded under:
docs/architecture/adr/Use:
docs/architecture/adr/ADR_TEMPLATE.mdRequired when decisions affect:
ADR records are descriptive artifacts under /docs authority and do not
override normative /spec definitions.
Subsystems own specific directories. New files must be placed accordingly.
| Subsystem | Owner Directory | Implementation | Specification |
|---|---|---|---|
| Core Types | core/types/ |
core/types/ |
spec/t81-data-types.md |
| TISC ISA | core/isa/ |
core/isa/ |
spec/tisc-spec.md |
| VM | core/vm/ |
core/vm/ |
spec/t81vm-spec.md |
| Language | lang/stdlib/ |
lang/stdlib/ |
spec/t81lang-spec.md |
| Axion | kernel/axion/ |
kernel/axion/ |
spec/axion-kernel.md |
| Docs | docs/ |
N/A | spec/index.md |
| Book | /docs/developer-guide/book/ |
N/A | N/A |