Skip to main content

Documentation Index

Documentation Map​

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​

  • Overview
  • Architecture (docs/ARCHITECTURE.md)
  • Capabilities (docs/CAPABILITIES.md)
  • Integrations (docs/INTEGRATIONS.md)
  • API (docs/API.md)

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)

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 (docs/ROADMAP.md)
  • Test Report (docs/TEST_REPORT.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​

CategoryCanonical SurfacePublish Policy
canonicalREADME.md, docs/README.md, docs/OVERVIEW.md, docs/MODULE_FEATURES.mdfull
operationaldocs/OPERATIONS.md (single canonical ops surface)full
plandocs/AUTONOMOUS_BACKLOG.mdnever
historicalmigration/cutover references for jhf-agent-runtime-kit compatibilitylink_only

License: AGPLv3
Project: https://helpifyr.com

Docs Platform v1.6 Base Family​

Evidence and Historical Material​

  • legacy and evidence surfaces remain supporting material in this repo.