Quick Start
Documentation Index
This index is the canonical navigation entrypoint for repository documentation.
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 - active owner blocker:
JaddaHelpifyr/jhf-keystore#244 - operator-only runbooks and live evidence remain explicit, but they are excluded from the current public release-candidate set
- repo-owned history evidence now runs through
python scripts/verify_repository_history_posture.py - canonical Gitea history remains private or internal; future public candidates use filtered publication from exact
main - the owner decision is recorded in
FILTERED_PUBLICATION_DECISION.md
Core Orientation
- Overview
- Install
- Configuration
- Operations
- Troubleshooting
- Release Notes
- Architecture
- Runbook
- Stack Contract (
docs/STACK_CONTRACT.md)
Contracts and Security
- Access Model (
docs/ACCESS_MODEL.md) - Fabric Tool Profile (
docs/FABRIC_TOOL_PROFILE.md) - Fabric Contract Adoption (
docs/FABRIC_CONTRACT_ADOPTION.md) - SSO v4 Acceptance Suite (
docs/SSO_V4_ACCEPTANCE_SUITE.md) - Vaultwarden SSO Consumer (
docs/VAULTWARDEN_SSO_CONSUMER.md) - Security
- Artifact Contract (
docs/ARTIFACT_CONTRACT.md) - Contract Consumption (
docs/CONTRACT_CONSUMPTION.md) - Boost Runtime Attestation Verification-Key Reference (
docs/BOOST_RUNTIME_ATTESTATION_VERIFICATION_KEY_REFERENCE.md) - Gitea CI OIDC Secret Posture (
docs/GITEA_CI_OIDC_SECRET_POSTURE.md) - Semantic Runtime Service Identity Posture (
docs/SEMANTIC_RUNTIME_SERVICE_IDENTITY_POSTURE.md) - Reed Context Gateway Runtime Input Admission (
docs/REED_CONTEXT_GATEWAY_RUNTIME_INPUT_ADMISSION.md) - Mem0-v2 Comparator Service Identity Admission (
docs/MEM0_V2_COMPARATOR_SERVICE_IDENTITY_ADMISSION.md) - Marketing mTLS Refs Admission (
docs/MARKETING_MTLS_REFS_ADMISSION.md) - Weft Connector Token Posture (
docs/WEFT_CONNECTOR_TOKEN_POSTURE.md) - Weft Phase 4 Token Rotation Readiness (
docs/WEFT_PHASE4_TOKEN_ROTATION_READINESS.md) - Weft Nextcloud OIDC Secret Posture (
docs/WEFT_NEXTCLOUD_OIDC_SECRET_POSTURE.md) - Weft OIDC Smoke Secret Posture (
docs/WEFT_OIDC_SMOKE_SECRET_POSTURE.md) - Weft Public Session Secret Owner Posture (
docs/WEFT_PUBLIC_SESSION_SECRET_OWNER_POSTURE.md) - Universal Connections Keystore Governance (
docs/UNIVERSAL_CONNECTIONS_KEYSTORE_GOVERNANCE.md) - Loom Proxy-SSO Smoke Secret Posture (
docs/LOOM_PROXY_SSO_SMOKE_SECRET_POSTURE.md)
Runtime, Verification, and Inventory
- Capabilities
- Module Features (
docs/MODULE_FEATURES.md) - CLI and Runtime Surfaces (
docs/CLI_AND_RUNTIME_SURFACES.md) - Verify and Operate (
docs/VERIFY_AND_OPERATE.md) - OSS Version Inventory (
docs/OSS_VERSION_INVENTORY.md) - OSS Inventory
- Event Modeling Wave 2 Keystore (
docs/EVENT_MODELING_W2_KEYSTORE.md) - Filtered Publication Decision (
docs/FILTERED_PUBLICATION_DECISION.md)
Program and Supporting References
- Autonomous Backlog (
docs/AUTONOMOUS_BACKLOG.md) - ERP Identity Access Program (
docs/ERP_IDENTITY_ACCESS_PROGRAM.md) - Access Model Program (
docs/ACCESS_MODEL_PROGRAM.md) - Owner Boundaries (
docs/OWNER_BOUNDARIES.md) - Release Runbook (
docs/RELEASE.md) - Vaultwarden Docker Notes (
docs/vaultwarden-docker.md)
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 |
| operational | docs/OPERATIONS.md | full |
| runbook | docs/TROUBLESHOOTING.md | full |
| plan | docs/AUTONOMOUS_BACKLOG.md | summary |
| evidence | docs/REALTIME_VOICE_V6_ACCEPTANCE.md, docs/REALTIME_VOICE_WAVE7_TREND_ACCEPTANCE.md | link_only |
AGPLv3. See LICENSE (LICENSE).
Learn more at helpifyr.com.