Quick Start
Documentation Index
This index keeps the existing documentation spine intact and points to the primary operator and contract documents.
Core Navigation
- Overview
- Install
- Configuration
- Architecture
- Operations
- Troubleshooting
- Release Notes
- Runbook
- API
- Module Features (
docs/MODULE_FEATURES.md) - Fabric Tool Profile (
docs/FABRIC_TOOL_PROFILE.md) - Operator Lane Followthrough (
docs/OPERATOR_LANE_FOLLOWTHROUGH.md)
Inventory / Publishing Controls
- Docs Manifest (
docs/docs.manifest.yaml) - Root Docs Contract (
docs_manifest.yml) - Validator:
python scripts/docs/validate_docs_inventory.py - Dry-run generator:
python scripts/docs/generate_wikijs_dry_run.py - Inventory builder:
python scripts/docs/build_docs_inventory.py --check - Public vs Internal Content (
docs/PUBLIC_VS_INTERNAL_CONTENT.md)
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) - Public vs Internal Content (
docs/PUBLIC_VS_INTERNAL_CONTENT.md)
Operator-only runtime, live evidence, deployment, backlog, and host-specific
surfaces remain canonical in Gitea but are excluded from public release
admission until a future owner issue changes that posture. 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-pattern#655. The deterministic preparation bundle is
built and verified outside the repository with
python scripts/build_filtered_publication_bundle.py.
License: AGPLv3
Helpifyr: https://helpifyr.com