Quick Start
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
- API.md
- OPERATIONS.md
- TROUBLESHOOTING.md
- RELEASE_NOTES.md
- MODULE_FEATURES.md (
docs/MODULE_FEATURES.md) - CAPABILITIES.md
- INTEGRATIONS.md
- STACK_RELATIONSHIPS.md (
docs/STACK_RELATIONSHIPS.md) - OSS_INVENTORY.md
- OSS_VERSION_GOVERNANCE.md (
docs/OSS_VERSION_GOVERNANCE.md) (compatibility alias) - PLAN_CLOSEOUT_MATRIX.md (
docs/PLAN_CLOSEOUT_MATRIX.md) - 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) - AGENT_KNOWLEDGE_PATHS.md (
docs/AGENT_KNOWLEDGE_PATHS.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) - JADDA_INTERFACE_POLICY_PROJECTION.md (
docs/JADDA_INTERFACE_POLICY_PROJECTION.md) - LOOM_OCR_AGENT_ACTION_POLICY.md (
docs/LOOM_OCR_AGENT_ACTION_POLICY.md) - WEFT_WORKSPACE_ACTION_POLICY.md (
docs/WEFT_WORKSPACE_ACTION_POLICY.md) - VOICE_REALTIME_POLICY_PROFILES.md (
docs/VOICE_REALTIME_POLICY_PROFILES.md) - AGENT_COORDINATION_CONTRACT.md (
docs/AGENT_COORDINATION_CONTRACT.md) - AGENT_RUNTIME_SAFETY_CONTRACT.md (
docs/AGENT_RUNTIME_SAFETY_CONTRACT.md) - HELPIFYR_AGENT_PLATFORM_CORE_NORMALIZATION.md (
docs/HELPIFYR_AGENT_PLATFORM_CORE_NORMALIZATION.md) - HELPIFYR_AGENT_UNIVERSAL_INTENT_ASSIGNMENT.md (
docs/HELPIFYR_AGENT_UNIVERSAL_INTENT_ASSIGNMENT.md) - HELPIFYR_DOUBTFIRE_EXECUTION_FOLLOWTHROUGH.md (
docs/HELPIFYR_DOUBTFIRE_EXECUTION_FOLLOWTHROUGH.md) - HELPIFYR_DOUBTFIRE_BOOST_LIFECYCLE.md (
docs/HELPIFYR_DOUBTFIRE_BOOST_LIFECYCLE.md) - HELPIFYR_UNIVERSAL_WORK_ORCHESTRATION.md (
docs/HELPIFYR_UNIVERSAL_WORK_ORCHESTRATION.md) - HELPIFYR_OPERATOR_LANE_OWNER_DECISION.md (
docs/HELPIFYR_OPERATOR_LANE_OWNER_DECISION.md) - HELPIFYR_OPERATOR_LANE_RESIDUAL_PAYABLE_FOLLOWTHROUGH.md (
docs/HELPIFYR_OPERATOR_LANE_RESIDUAL_PAYABLE_FOLLOWTHROUGH.md) - HELPIFYR_PLAN_STUDIO_EXECUTION_BOUNDARY.md (
docs/HELPIFYR_PLAN_STUDIO_EXECUTION_BOUNDARY.md) - HELPIFYR_STACK_OWNER_MATRIX_PROJECTION.md (
docs/HELPIFYR_STACK_OWNER_MATRIX_PROJECTION.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) - RUNTIME_DISCOVERY_CACHE_CONTRACT.md (
docs/RUNTIME_DISCOVERY_CACHE_CONTRACT.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
- 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.mdis the human landing page, not the full operational encyclopedia.MODULE_FEATURES.mdis 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 <live-host>
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
Release Eligibility Posture
- Public release-surface admission is bounded by
../contracts/admission/release_surface_inventory_v1.json. - Current repository history posture is tracked in
../contracts/admission/repository_publication_history_posture_v1.json. - Active owner follow-up issue:
JaddaHelpifyr/jhf-warp#564. jhf-warpremainspending_history_scan; repo-owned history evidence now runs throughpython scripts/verify_repository_history_posture.pyand currently provesfiltered_publication_required, while operator-only manifests and live runbooks stay explicit but outside public release-surface admission.- The non-destructive owner decision for future filtered public publication is documented in FILTERED_PUBLICATION_DECISION.md (
docs/FILTERED_PUBLICATION_DECISION.md).
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.