Skip to main content

Spindle Documentation Index

Documentation Map

Docs Index

This index is the canonical short entrypoint for jhf-spindle documentation.

Core Orientation

Documentation Classes

The repo still separates documentation into three primary truth classes:

  • business-truth
    • runtime/domain behavior and operator-facing understanding
    • examples: README.md, docs/OVERVIEW.md, docs/ARCHITECTURE.md
  • contracts
    • machine-readable protocol/contract surfaces
    • examples: docs/contracts/*.json
  • plans
    • execution plans, rollout plans, and acceptance-tracking pages
    • conservative publish by default (summary, link_only, or never)

Publishing Posture

Conservative publishing posture:

  • historical/evidence pages are not full-published
  • acceptance-heavy pages are link-first unless explicitly promoted
  • see docs/docs.manifest.yaml for canonical class/policy rules

License notice: AGPLv3 (GNU Affero General Public License v3.0)
Website: https://helpifyr.com