Skip to main content

Quick Start

Documentation Index

This page is the repo-owned documentation landing page for jhf-shuttle. Use it as the canonical map for deeper technical, operational, and contract documentation.

Start Here​

Public Surfaces​

  • API
  • Mission Control API (docs/MISSION_CONTROL_API.md)
  • Integrations
  • Security
  • Public vs Internal Content Policy (docs/PUBLIC_VS_INTERNAL_CONTENT.md)
  • contracts/admission/release_surface_inventory_v1.json
  • contracts/admission/repository_publication_history_posture_v1.json

Runtime And Verify​

  • Self Stack Runbook (docs/JHF_SHUTTLE_SELF_STACK_RUNBOOK.md)
  • Runbook
  • Helpifyr Explainer Video Workflow (docs/HELPIFYR_EXPLAINER_VIDEO_WORKFLOW.md)
  • Self-Stack n8n Postgres Migration Plan (docs/PLAN_SELF_STACK_N8N_POSTGRES_MIGRATION.md)
  • Final Release Hardening (docs/FINAL_RELEASE_HARDENING.md)
  • End-To-End Regression Pass (docs/END_TO_END_REGRESSION_PASS.md)
  • Testing Index

Docs Inventory v1​

  • source standard: helpifyr-docs-inventory-v1
  • canonical manifest: docs/docs.manifest.yaml
  • canonical validator: python scripts/docs/validate_docs_inventory.py
  • canonical builder: python scripts/docs/build_docs_inventory.py --write
  • drift-first evidence: docs/DRIFT_REVIEW_2026-04-28.md
  • conservative evidence rule: runtime/bootstrap evidence docs remain wiki_publish_policy=never and are not canonical full-publish targets

Governance And Contracts​

  • Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
  • Reed Adapter Manifest v2 (docs/REED_ADAPTER_MANIFEST_V2.md)
  • Reed Sandbox Write Lanes v1 (docs/REED_SANDBOX_WRITE_LANES.md)
  • Reed Read-Only Owner Surface (docs/REED_READ_ONLY_OWNER_SURFACE.md)
  • Event Modeling Shuttle Core W1 (docs/EVENT_MODELING_SHUTTLE_CORE_W1.md)
  • OSS Inventory
  • Issue #138 Evidence (docs/ISSUE_138_OSS_INVENTORY_VERSION_TRUTH_EVIDENCE_2026-04-27.md)
  • Issue #139 Evidence (docs/ISSUE_139_PARSE_FIRST_OPENCLAW_JSON_FALLBACK_EVIDENCE_2026-04-27.md)
  • A2A Handoff Evidence Contract (docs/A2A_HANDOFF_EVIDENCE_CONTRACT.md)
  • Agent Message Contract (docs/AGENT_MESSAGE_CONTRACT.md)
  • Governance And Release Matrix (docs/GOVERNANCE_AND_RELEASE_MATRIX.md)
  • Stack Relationships (docs/STACK_RELATIONSHIPS.md)

Planning And Scope​

  • Project Plan
  • Autonomous Backlog (docs/AUTONOMOUS_BACKLOG.md)
  • Known Limitations (docs/KNOWN_LIMITATIONS.md)

Evidence And Historical​

  • Issue #134 Evidence (docs/ISSUE_134_REED_ADAPTER_MANIFEST_V2_EVIDENCE_2026-04-26.md)
  • Issue #136 Evidence (docs/ISSUE_136_REED_SANDBOX_WRITE_LANES_EVIDENCE_2026-04-26.md)
  • Drift Review 2026-04-28 (docs/DRIFT_REVIEW_2026-04-28.md)

Canonical Guidance​

  • README.md is the human landing page.
  • docs/MODULE_FEATURES.md is the machine-readable QA-oriented feature surface.
  • docs/RUNTIME_STACK_CONTRACT.md is the repo-owned stack/runtime truth.
  • docs/FILTERED_PUBLICATION_DECISION.md records the non-destructive owner decision for future filtered public publication.
  • contracts/admission/release_surface_inventory_v1.json is the bounded public stack-nightly admission inventory.
  • contracts/admission/repository_publication_history_posture_v1.json keeps release eligibility at pending_history_scan until history review is complete and now points to repo-owned history evidence via python scripts/verify_repository_history_posture.py.
  • Fabric-owned governance truth must be consumed read-only and not redefined locally.

AGPLv3. Learn more at helpifyr.com.