Skip to main content

Documentation Index

Documentation Map​

Documentation Index

This index is the canonical navigation page for jhf-warp documentation. It keeps the repo-owned docs spine small, categorized, and safe to publish without turning evidence or plans into shadow truth.

Canonical Docs​

  • ../README.md
  • OVERVIEW.md
  • INSTALL.md
  • CONFIGURATION.md
  • ARCHITECTURE.md (docs/ARCHITECTURE.md)
  • API.md (docs/API.md)
  • OPERATIONS.md
  • TROUBLESHOOTING.md
  • RELEASE_NOTES.md
  • MODULE_FEATURES.md (docs/MODULE_FEATURES.md)
  • CAPABILITIES.md (docs/CAPABILITIES.md)
  • INTEGRATIONS.md (docs/INTEGRATIONS.md)
  • STACK_RELATIONSHIPS.md (docs/STACK_RELATIONSHIPS.md)
  • OSS_INVENTORY.md (docs/OSS_INVENTORY.md)
  • OSS_VERSION_GOVERNANCE.md (docs/OSS_VERSION_GOVERNANCE.md) (compatibility alias)
  • docs.manifest.yaml (docs/docs.manifest.yaml)

Contracts​

  • FABRIC_TOOL_PROFILE.md (docs/FABRIC_TOOL_PROFILE.md)
  • FABRIC_TRUTH_CONSUMPTION.md (docs/FABRIC_TRUTH_CONSUMPTION.md)
  • AGENT_GOVERNANCE_IDENTITY_CONTRACT.md (docs/AGENT_GOVERNANCE_IDENTITY_CONTRACT.md)
  • AGENT_CAPABILITY_POLICY_PROJECTION.md (docs/AGENT_CAPABILITY_POLICY_PROJECTION.md)
  • AGENT_TEAM_HANDOFF_LIFECYCLE_CONTRACT.md (docs/AGENT_TEAM_HANDOFF_LIFECYCLE_CONTRACT.md)
  • AGENT_TOOL_POLICY_CONTRACT.md (docs/AGENT_TOOL_POLICY_CONTRACT.md)
  • EVENT_MODELING_CORE_ADOPTION_CONTRACT.md (docs/EVENT_MODELING_CORE_ADOPTION_CONTRACT.md)
  • SANDBOX_APPROVAL_POLICY_CONTRACT.md (docs/SANDBOX_APPROVAL_POLICY_CONTRACT.md)
  • AGENT_MANIFEST_V2_CLAIM_OWNER_COMPATIBILITY.md (docs/AGENT_MANIFEST_V2_CLAIM_OWNER_COMPATIBILITY.md)
  • AGENT_COORDINATION_CONTRACT.md (docs/AGENT_COORDINATION_CONTRACT.md)
  • AGENT_RUNTIME_SAFETY_CONTRACT.md (docs/AGENT_RUNTIME_SAFETY_CONTRACT.md)
  • VOICE_AGENT_SCHEMA.md (docs/VOICE_AGENT_SCHEMA.md)
  • VOICE_APPROVAL_POLICY_CONTRACT.md (docs/VOICE_APPROVAL_POLICY_CONTRACT.md)
  • VOICE_LIBRARY_GOVERNANCE_CONTRACT.md (docs/VOICE_LIBRARY_GOVERNANCE_CONTRACT.md)
  • OPENCLAW_SKILL_SPEC.md (docs/OPENCLAW_SKILL_SPEC.md)
  • OPENCLAW_SKILL_GOVERNANCE.md (docs/OPENCLAW_SKILL_GOVERNANCE.md)

Operational Docs​

  • RUNTIME_SERVICE_FLOWS.md (docs/RUNTIME_SERVICE_FLOWS.md)
  • PRODUCTION_STACK_DEPLOYMENT.md (docs/PRODUCTION_STACK_DEPLOYMENT.md)
  • STACK_CONTAINER_CONTRACT.md (docs/STACK_CONTAINER_CONTRACT.md)
  • STANDALONE_INTEGRATED_CONTRACT.md (docs/STANDALONE_INTEGRATED_CONTRACT.md)
  • INTERNAL_RELEASE_GATE.md (docs/INTERNAL_RELEASE_GATE.md)
  • RELEASE_CHECKLIST.md (docs/RELEASE_CHECKLIST.md)
  • RELEASE_READINESS_BASELINE.md (docs/RELEASE_READINESS_BASELINE.md)

Runbooks​

  • OPERATOR_RUNBOOK.md (docs/OPERATOR_RUNBOOK.md)
  • RUNBOOK.md
  • POST_RELEASE_OBSERVATION_ROLLBACK_PLAYBOOK.md (docs/POST_RELEASE_OBSERVATION_ROLLBACK_PLAYBOOK.md)

Plans and Evidence​

  • AUTONOMOUS_BACKLOG.md (docs/AUTONOMOUS_BACKLOG.md)
  • AUTONOMOUS_STATE.md (docs/AUTONOMOUS_STATE.md)
  • ROADMAP.md (docs/ROADMAP.md)
  • PROJECT_PLAN.md (docs/PROJECT_PLAN.md)
  • RELEASE_SIGNOFF.md (docs/RELEASE_SIGNOFF.md)
  • CONTROL_AGENT_EVIDENCE_2026-03-30.md (docs/CONTROL_AGENT_EVIDENCE_2026-03-30.md)
  • LIVE_TEST_EVIDENCE_2026-03-29.md (docs/LIVE_TEST_EVIDENCE_2026-03-29.md)
  • PRODUCTION_LIVE_TEST_EVIDENCE_2026-03-29.md (docs/PRODUCTION_LIVE_TEST_EVIDENCE_2026-03-29.md)
  • RELEASE_CANDIDATE_EVIDENCE_PACK_2026-04-12.md (docs/RELEASE_CANDIDATE_EVIDENCE_PACK_2026-04-12.md)
  • issues/README.md

Source-of-Truth Rules​

  • Gitea is the source of truth for active work.
  • README.md is the human landing page, not the full operational encyclopedia.
  • MODULE_FEATURES.md is the QA-facing feature truth for automated test derivation.
  • contract and runtime details belong in the specialized docs under this directory, not in the landing page.

Verification Entry Points​

Common repo-side validation commands:

./scripts/check.sh
python scripts/verify_docs_inventory.py
python scripts/verify_runtime_materialization.py
python scripts/verify_runtime_materialization.py --host <internal-runtime-redacted>
python scripts/verify_stack_contract.py
python scripts/verify_event_modeling_core_adoption.py
python scripts/verify_runtime_guardrails.py --report artifacts/runtime-guardrails-report.json
python scripts/verify_docs_rc_readiness.py
python scripts/verify_oss_inventory.py

For live/runtime-sensitive checks, follow OPERATIONS.md and OPERATOR_RUNBOOK.md (docs/OPERATOR_RUNBOOK.md).

License​

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.