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
  • Install
  • Configuration
  • Capabilities (docs/CAPABILITIES.md)
  • Architecture (docs/ARCHITECTURE.md)
  • 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)
  • 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 Wave 3 Adoption (docs/FABRIC_WAVE3_ADOPTION.md)

Runtime, Operations, and Verify​

  • Canonical ops surface: Operations (single source for runtime operations posture in this repo)
  • API Surfaces (docs/API.md)
  • Troubleshooting
  • Release Notes
  • Deployment Notes (docs/DEPLOYMENT.md)
  • OSS Inventory And Version Truth (docs/OSS_INVENTORY.md)
  • 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)
  • 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)
  • Drift Review 2026-04-28 (docs/DRIFT_REVIEW_2026-04-28.md)

Inventory Categories​

CategoryCanonical SurfacePublish Policy
canonicalREADME.md, docs/README.md, docs/OVERVIEW.md, docs/INSTALL.md, docs/CONFIGURATION.md, docs/MODULE_FEATURES.md, docs/RELEASE_NOTES.mdfull
operationaldocs/OPERATIONS.md (single canonical ops surface)full
runbookdocs/TROUBLESHOOTING.mdfull
plandocs/AUTONOMOUS_BACKLOG.mdnever
evidencedocs/DRIFT_REVIEW_2026-04-28.mdnever

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