documentation_system

Documentation system contracts and evidence model for M46.

Types

DocumentationBundle

One milestone-scoped documentation bundle.

pub type DocumentationBundle {
  DocumentationBundle(
    milestone: String,
    architecture_doc: String,
    operations_doc: String,
    testing_doc: String,
    upgrade_doc: String,
    troubleshooting_doc: String,
    module_refs: List(String),
    fixture_report: String,
    fixture_gate: String,
  )
}

Constructors

DocumentationBundle(
  milestone: String,
  architecture_doc: String,
  operations_doc: String,
  testing_doc: String,
  upgrade_doc: String,
  troubleshooting_doc: String,
  module_refs: List(String),
  fixture_report: String,
  fixture_gate: String,
)

Values

bundle

pub fn bundle(
  milestone: String,
  architecture_doc: String,
  operations_doc: String,
  testing_doc: String,
  upgrade_doc: String,
  troubleshooting_doc: String,
  module_refs: List(String),
  fixture_report: String,
  fixture_gate: String,
) -> DocumentationBundle

Build one documentation bundle.

coherent_system

pub fn coherent_system() -> Bool

Check all bundles are coherent and ordered.

drift_check_contracts

pub fn drift_check_contracts() -> Bool

True when all bundles expose stable module and fixture drift-check surfaces.

evidence_requirement_signature

pub fn evidence_requirement_signature() -> String

Stable evidence-requirement signature.

evidence_requirements

pub fn evidence_requirements() -> List(String)

Required documentation evidence when milestone contracts change.

fixture_gate

pub fn fixture_gate(bundle: DocumentationBundle) -> String

Bundle fixture gate accessor.

fixture_reference_signature

pub fn fixture_reference_signature(
  bundle: DocumentationBundle,
) -> String

Stable fixture-reference signature.

fixture_report

pub fn fixture_report(bundle: DocumentationBundle) -> String

Bundle fixture report accessor.

m40_bundle

pub fn m40_bundle() -> DocumentationBundle

M40 bundle.

m41_bundle

pub fn m41_bundle() -> DocumentationBundle

M41 bundle.

m42_bundle

pub fn m42_bundle() -> DocumentationBundle

M42 bundle.

m43_bundle

pub fn m43_bundle() -> DocumentationBundle

M43 bundle.

m44_bundle

pub fn m44_bundle() -> DocumentationBundle

M44 bundle.

m45_bundle

pub fn m45_bundle() -> DocumentationBundle

M45 bundle.

m46_bundle

pub fn m46_bundle() -> DocumentationBundle

M46 bundle.

milestone

pub fn milestone(bundle: DocumentationBundle) -> String

Bundle milestone accessor.

module_reference_signature

pub fn module_reference_signature(
  bundle: DocumentationBundle,
) -> String

Stable module-reference signature.

module_refs

pub fn module_refs(bundle: DocumentationBundle) -> List(String)

Bundle module refs accessor.

reference_bundles

pub fn reference_bundles() -> List(DocumentationBundle)

All reference bundles for M40–M46.

signature

pub fn signature(bundle: DocumentationBundle) -> String

Stable bundle signature.

snapshot_signature

pub fn snapshot_signature() -> String

Deterministic snapshot signature for M46 fixture drift gates.

snapshot_version

pub const snapshot_version: Int

upgrade_troubleshooting_signature

pub fn upgrade_troubleshooting_signature(
  bundle: DocumentationBundle,
) -> String

Stable upgrade/troubleshooting signature.

valid_bundle

pub fn valid_bundle(bundle: DocumentationBundle) -> Bool

Check one bundle is coherent.

versioned_troubleshooting_paths

pub fn versioned_troubleshooting_paths() -> List(String)

Versioned milestone troubleshooting paths.

versioned_upgrade_paths

pub fn versioned_upgrade_paths() -> List(String)

Versioned milestone upgrade paths.