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.
Current release-eligibility posture:
- public release-surface inventory:
contracts/admission/release_surface_inventory_v1.json - history-admission posture:
contracts/admission/repository_publication_history_posture_v1.json - filtered publication owner decision:
FILTERED_PUBLICATION_DECISION.md - active owner blocker:
JaddaHelpifyr/jhf-heddle#329 - operator-only docs stay in the repo, but they are excluded from the current public release-candidate set until history and surface evidence are complete
- repo-owned history evidence now runs through
python scripts/verify_repository_history_posture.py - the current owner-selected path is non-destructive filtered publication from exact
main, not canonical history rewrite
Core Orientation
- Overview
- Install
- Configuration
- Security
- Capabilities
- Architecture
- Stack Contract (
docs/STACK_CONTRACT.md)
Contracts and Identity Posture
- Fabric Tool Profile (
docs/FABRIC_TOOL_PROFILE.md) - Token Claim Contract (
docs/TOKEN_CLAIM_CONTRACT.md) - SSO v4 Claim Session Core (
docs/SSO_V4_CLAIM_SESSION_CORE.md) - Session and Revocation (
docs/SESSION_AND_REVOCATION.md) - Provider Profile (
docs/PROVIDER_PROFILE.md) - OIDC Client Templates (
docs/OIDC_CLIENT_TEMPLATES.md) - Plan Studio Reviewer And Operator Claims (
docs/PLAN_STUDIO_REVIEWER_OPERATOR_CLAIMS.md) - Weft Connector And Agent Mail Identity Posture (
docs/WEFT_CONNECTOR_AGENT_MAIL_IDENTITY_POSTURE.md) - Weft Mail Component Admission (
docs/WEFT_MAIL_COMPONENT_ADMISSION.md) - Weft Public Session Owner Posture (
docs/WEFT_PUBLIC_SESSION_OWNER_POSTURE.md) - Rocket.Chat Jadda Interface Principal Mapping (
docs/ROCKETCHAT_JADDA_INTERFACE_PRINCIPAL_MAPPING.md) - Admitted Surface Client Contracts (
docs/ADMITTED_SURFACE_CLIENT_CONTRACTS.md) - Future Module Onboarding (
docs/FUTURE_MODULE_ONBOARDING.md) - Reed Delegated Agent Principal Contract (
docs/REED_DELEGATED_AGENT_PRINCIPAL_CONTRACT.md) - Reed Module Adapter Manifest (
docs/REED_MODULE_ADAPTER_MANIFEST.md) - Reed Adapter Handoff Readback Ownership Evidence (
docs/REED_ADAPTER_HANDOFF_READBACK_OWNERSHIP_EVIDENCE.md) - Reed Read-Only Owner Adapter Surface (
docs/REED_READONLY_OWNER_ADAPTER_SURFACE.md) - Event Modeling Wave 2 Identity Runtime (
docs/EVENT_MODELING_W2_IDENTITY_RUNTIME.md)
Fabric Consumer Surfaces
- Fabric Consumer Surfaces (
docs/FABRIC_CONSUMER_SURFACES.md) - Fabric Combination Consumer (
docs/FABRIC_COMBINATION_CONSUMER.md) - Fabric Plane Unified Access Consumer (
docs/FABRIC_PLANE_UNIFIED_ACCESS_CONSUMER.md) - Fabric Contract Adoption (
docs/FABRIC_CONTRACT_ADOPTION.md)
Runtime, Operations, and Verify
- Canonical ops surface: Operations (single source for runtime operations posture in this repo)
- API Surfaces
- Troubleshooting
- Release Notes
- Deployment Notes (
docs/DEPLOYMENT.md) - OSS Inventory And Version Truth
- Host Docker Log Guardrails (
docs/HOST_DOCKER_LOG_GUARDRAILS.md) - Shared Host Profile (
docs/SHARED_HOST_PROFILE.md) - Runbook: Bootstrap (
docs/runbooks/BOOTSTRAP.md) - Runbook: Backup Restore (
docs/runbooks/BACKUP_RESTORE.md) - Runbook: Secret Rotation (
docs/runbooks/SECRET_ROTATION.md)
Product/Surface-Specific Guides
- OIDC Surfaces and Bootstraps (
docs/OIDC_SURFACES_AND_BOOTSTRAPS.md) - Plane OIDC Bootstrap (
docs/PLANE_OIDC_BOOTSTRAP.md) - Loom OIDC Bootstrap (
docs/LOOM_OIDC_BOOTSTRAP.md) - Weft Nextcloud OIDC Bootstrap (
docs/WEFT_NEXTCLOUD_OIDC_BOOTSTRAP.md) - Lantern OIDC Bootstrap (
docs/LANTERN_OIDC_BOOTSTRAP.md) - ERP/Frappe OIDC Bootstrap (
docs/FRAPPE_ERP_OIDC_BOOTSTRAP.md) - Zammad OIDC Bootstrap (
docs/ZAMMAD_OIDC_BOOTSTRAP.md) - Asterisk GUI OIDC Bootstrap (
docs/ASTERISK_GUI_OIDC_BOOTSTRAP.md) - Vaultwarden OIDC Bootstrap (
docs/VAULTWARDEN_OIDC_BOOTSTRAP.md) - JHF Web OIDC Service Contract (
docs/JHF_WEB_OIDC_SERVICE_CONTRACT.md)
Reconcile and Federation
- Agent Reconcile and GC (
docs/AGENT_RECONCILE_AND_GC.md) - Agent Federation Consumer (
docs/AGENT_FEDERATION_CONSUMER.md) - Agent Federation Operations (
docs/AGENT_FEDERATION_OPERATIONS.md) - Technical Sync Surfaces (
docs/TECHNICAL_SYNC_SURFACES.md)
QA / Backlog Surfaces
- Module Features (
docs/MODULE_FEATURES.md) - Autonomous Backlog (
docs/AUTONOMOUS_BACKLOG.md)
Historical / Evidence Surfaces
- Fabric Wave 3 Adoption (
docs/FABRIC_WAVE3_ADOPTION.md) - historical rollout/adoption evidence; current canonical adoption truth lives indocs/FABRIC_CONTRACT_ADOPTION.md - Drift Review 2026-04-28 (
docs/DRIFT_REVIEW_2026-04-28.md) - evidence-only drift snapshot; intentionally non-canonical and non-published
Inventory Categories
| Category | Canonical Surface | Publish Policy |
|---|---|---|
| canonical | README.md, docs/README.md, docs/OVERVIEW.md, docs/INSTALL.md, docs/CONFIGURATION.md, docs/MODULE_FEATURES.md, docs/RELEASE_NOTES.md | full |
| security | docs/SECURITY.md | full |
| operational | docs/OPERATIONS.md (single canonical ops surface) | full |
| runbook | docs/TROUBLESHOOTING.md | full |
| plan | docs/AUTONOMOUS_BACKLOG.md | never |
| evidence | docs/DRIFT_REVIEW_2026-04-28.md | never |
License: AGPLv3 Project: https://helpifyr.com