166-deterministic-reference-documentation

Generate one deterministic reference page per spec

Lifecycle approvedImplementation completeVerification unknownQualification unknown

Adds one bounded, fixed-export reference product: one Markdown page per exported spec, projected from a typed page model whose every field comes from a named ledger source (registry, index, selected content, declared traceability, capability catalog). Pages have fixed generated regions and one human-authored region, canonical bytes, declared-not-run executable examples, and a read-only regeneration check that exits 1 when committed pages differ. Narrative documentation stays outside the product.

Read the full pinned specification ↗

Relationships

depends on

depended on by

197-reference-documentation-ships-without-a-manifest

amended by

197-reference-documentation-ships-without-a-manifest

Claimed units

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-types/src/reference.rs"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-types/schemas/reference-page.schema.json"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-core/src/reference.rs"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-core/tests/reference.rs"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-core/tests/reference_schema.rs"
}

establishes

{
  "kind": "directory",
  "path": "crates/spec-spine-core/tests/fixtures/reference/"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-cli/src/cmd_reference.rs"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-cli/tests/reference.rs"
}

establishes

{
  "kind": "file",
  "path": "crates/spec-spine-cli/tests/reference_examples.rs"
}

establishes

{
  "anchor": "reference-documentation",
  "file": "docs/reference-documentation.md",
  "kind": "section"
}

extends

{
  "nature": "additive",
  "spec": "001-compile-registry",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-types/src/lib.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "074-a-governed-read-names-its-version",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-types/src/version.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "001-compile-registry",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-core/src/lib.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "002-registry-query",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/src/main.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "057-the-docs-name-what-adopters-derived",
  "unit": {
    "kind": "file",
    "path": "docs/api.md"
  }
}

extends

{
  "nature": "additive",
  "spec": "057-the-docs-name-what-adopters-derived",
  "unit": {
    "anchor": "cli-reference",
    "file": "docs/cli-reference.md",
    "kind": "section"
  }
}

extends

{
  "nature": "additive",
  "spec": "057-the-docs-name-what-adopters-derived",
  "unit": {
    "kind": "file",
    "path": "docs/schema-versioning.md"
  }
}

extends

{
  "nature": "additive",
  "spec": "022-index-sharding",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-types/src/schema.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "162-capability-catalog",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-core/src/capability.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "034-machine-readable-verdicts",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-types/src/verdict.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "162-capability-catalog",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-core/tests/capability_catalog.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "162-capability-catalog",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/tests/capability_catalog.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "170-a-consumer-is-served-answers-not-access",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/src/cmd_capabilities.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "170-a-consumer-is-served-answers-not-access",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/tests/capabilities.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "152-a-refusal-says-what-it-is-in-every-form",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/tests/refusal_envelopes.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "155-selected-content-accessor",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-core/src/content.rs"
  }
}

Source headings

166: Generate one deterministic reference page per spec
1. Purpose
2. Territory
3. Behavior
3.1 One export, one page kind
3.2 Export request
3.3 Page model and output schema
3.4 Fields and their sources
3.5 Markdown projection and canonical bytes
3.6 Generated and authored regions
3.7 Executable examples are declared, not run
3.8 Inputs are explicit and ambient reads are forbidden
3.9 Generation
3.10 The regeneration check
3.11 Manifest binding
3.12 Limits, errors, and exit codes
3.13 Schema evolution
3.14 Authority and disclosure boundary
4. Acceptance criteria
5. Out of scope
6. Resolved decisions
Verification

Frozen anchors

No frozen anchors declared.