Quick Start
Documentation Index
This index is the canonical navigation entrypoint for repository documentation.
Use this file when you need deeper detail than the top-level README.md.
Core Orientation
Runtime And Operations
- Canonical ops surface: Operations (single source for runtime operations posture in this repo)
- Runbook
- Setup (
docs/SETUP.md) - Troubleshooting
- Script Index (
docs/SCRIPT_INDEX.md) - Releases And Upgrades (
docs/UPGRADE_RUNBOOK_SUITE.md) - Upgrade Tests (
docs/UPGRADE_TEST_SUITE.md)
Voice Runtime Contracts
- Voice Router Runtime Slice (
docs/VOICE_ROUTER_RUNTIME_SLICE.md) - Voice STT TTS OpenClaw Flow Slice (
docs/VOICE_STT_TTS_OPENCLAW_FLOW_SLICE.md) - Voice Runtime Validation Matrix (
docs/VOICE_RUNTIME_VALIDATION_MATRIX.md) - Voice Asterisk ARI Adapter Slice (
docs/VOICE_ASTERISK_ARI_ADAPTER_SLICE.md) - Voice UX Contract (
docs/VOICE_UX_CONTRACT.md) - Voice Configuration (
docs/VOICE_CONFIGURATION.md) - Voice Media Contract (
docs/VOICE_MEDIA_CONTRACT.md) - Voice Corner Cases (
docs/VOICE_CORNER_CASES.md) - Jadda Interface LiveKit Consumer Contract (
docs/JADDA_INTERFACE_LIVEKIT_CONSUMER_CONTRACT.md) - Jadda Meeting Request Intake Boundary (
docs/JADDA_MEETING_REQUEST_INTAKE_BOUNDARY.md) - Voice Consumer Gate Posture (
docs/VOICE_CONSUMER_GATE_POSTURE.md)
Asterisk And Operator Surfaces
- Asterisk Runtime Stack Source Of Truth (
docs/ASTERISK_RUNTIME_STACK_SOURCE_OF_TRUTH.md) - Asterisk GUI Operator Surface Consumer (
docs/ASTERISK_GUI_OPERATOR_SURFACE_CONSUMER.md) - Asterisk GUI SSO Handoff (
docs/ASTERISK_GUI_SSO_HANDOFF.md) - Voice Direct Target Operator Call (
docs/VOICE_DIRECT_TARGET_OPERATOR_CALL.md)
Fabric And Governance
- Fabric Tool Profile (
docs/FABRIC_TOOL_PROFILE.md) - Fabric Producer Consumer Adoption (
docs/FABRIC_PRODUCER_CONSUMER_ADOPTION.md) - Fabric Consumption And Governance (
docs/FABRIC_CONSUMPTION_AND_GOVERNANCE.md) - Fabric Combination Profile Consumer (
docs/FABRIC_COMBINATION_PROFILE_CONSUMER.md)
Planning And QA
- Module Features (
docs/MODULE_FEATURES.md) - Autonomous Backlog (
docs/AUTONOMOUS_BACKLOG.md) - Roadmap
- Test Report (
docs/TEST_REPORT.md) - Public vs Internal Content (
docs/PUBLIC_VS_INTERNAL_CONTENT.md)
Legacy Compatibility And Migration
- Host Install Migration jhf-agent-runtime-kit to jhf-tenter (
docs/HOST_INSTALL_MIGRATION_JHF_AGENT_RUNTIME_TO_JHF_TENTER.md) - Downstream Slug Cutover Inventory (
docs/DOWNSTREAM_SLUG_CUTOVER_INVENTORY.md)
Inventory Categories
| Category | Canonical Surface | Publish Policy |
|---|---|---|
| canonical | README.md, docs/README.md, docs/OVERVIEW.md, docs/MODULE_FEATURES.md | full |
| operational | docs/OPERATIONS.md (single canonical ops surface) | full |
| plan | docs/AUTONOMOUS_BACKLOG.md | never |
| historical | migration/cutover references for jhf-agent-runtime-kit compatibility | link_only |
License: AGPLv3 Project: https://helpifyr.com
Docs Platform v1.6 Base Family
- Overview
- Installation
- Configuration
- Operations
- Troubleshooting
- Release Notes
- Root Docs Manifest (
docs_manifest.yml)
Evidence and Historical Material
- legacy and evidence surfaces remain supporting material in this repo.
Release Admission Boundary
The bounded public stack-nightly release surfaces for this repository are defined in:
- contracts/admission/repository_publication_history_posture_v1.json (
contracts/admission/repository_publication_history_posture_v1.json) - contracts/admission/release_surface_inventory_v1.json (
contracts/admission/release_surface_inventory_v1.json) - contracts/admission/filtered_publication_bundle_policy_v1.json (
contracts/admission/filtered_publication_bundle_policy_v1.json)
Repository-history evidence now runs through
python scripts/verify_repository_history_posture.py and currently keeps the
repo at filtered_publication_required under JaddaHelpifyr/jhf-tenter#651.
The owner-side filtered bundle is built and verified only from an exact clean
main checkout into an external directory; implementation is tracked in #662.
- PUBLIC_VS_INTERNAL_CONTENT.md (
docs/PUBLIC_VS_INTERNAL_CONTENT.md)
Operator-only runtime, evidence, backlog, and host-specific documents remain in Gitea but are excluded from public release admission until a future owner issue changes that posture.
The current owner-bounded follow-up for that posture is
JaddaHelpifyr/jhf-tenter#651.