Skip to content

Publish an architecture, invariant, and artifact-contract reference for users and contributors #33

Description

@clintecker

Problem

The most valuable design ideas live across README, ROADMAP, CLAUDE.md, comments, and agent instructions. Public users cannot easily tell what is guaranteed, generated, verified, optional, or merely planned.

Acceptance criteria

  • Architecture document explains book/press/toolchain boundaries and one-truth-many-projections.
  • Invariant matrix names every invariant, enforcement boundary, known-bad proof, and limitation.
  • Artifact matrix lists builders, inputs, outputs, verifiers, and publication destinations.
  • Configuration reference includes schemas and examples.
  • Explicitly distinguish generated provenance from current verification.
  • Document design-versioning and breaking-change policy.
  • README leads with differentiated value and links to these references rather than agent-only docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsPublic documentation and contract accuracyarea:verificationExecutable contracts and artifact verificationaudit-3Findings from audit round 3documentationImprovements or additions to documentationpriority:P1High: required for a trustworthy supported workflowpublic-readinessRequired before independent public consumptiontest-layer:L0Invariant inventory and collection-time contract gates

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions