160-documentation-manifest-and-freshness

Declare documentation inputs and freshness

Lifecycle approvedImplementation completeVerification unknownQualification unknown

Adds a deterministic documentation-manifest document and a read-only freshness evaluation. A manifest binds one repository-scoped context packet, declared local and external inputs, generator identity, output bytes, generated and human-authored regions, and executable-example identities. Freshness names every changed, missing, unresolved, or unverified declared input without claiming that unchanged inputs make narrative text correct.

Read the full pinned specification ↗

Relationships

depends on

depended on by

Claimed units

establishes

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

establishes

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

establishes

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

establishes

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

establishes

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

establishes

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

establishes

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

establishes

{
  "anchor": "documentation-manifests",
  "file": "docs/documentation-manifests.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": "110-an-interface-reference-is-digest-pinned",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-core/src/interface.rs"
  }
}

extends

{
  "nature": "additive",
  "spec": "002-registry-query",
  "unit": {
    "kind": "file",
    "path": "crates/spec-spine-cli/src/main.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/src/capability.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": "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"
  }
}

Source headings

160: Declare documentation inputs and freshness
1. Purpose
2. Territory
3. Behavior
3.1 One manifest, one packet and generator run
3.2 Closed manifest document
3.3 Packet identity
3.4 Repository-local inputs
3.5 External interface inputs
3.6 Opaque external references
3.7 Generator identity
3.8 Outputs and regions
3.9 Executable-example identities
3.10 Freshness evaluation
3.11 Freshness status and precedence
3.12 Ambiguity, omissions, and completeness
3.13 Ordering, limits, canonical bytes, and schema evolution
3.14 Snapshot and stale-manifest behavior
3.15 Error and exit behavior
3.16 Authority, security, and disclosure boundary
4. Acceptance criteria
5. Out of scope
6. Resolved decisions
Verification

Frozen anchors

No frozen anchors declared.