Skip to main content

Configuration

Documentation Map​

Configuration

Purpose​

This page documents the canonical configuration posture for jhf-fabric and the docs platform itself.

Configuration Sources​

  • environment variables consumed by runtime services
  • contract JSON under contracts/**
  • docs manifests under docs/docs.manifest.yaml and docs_manifest.yml
  • generated inventory and docs-state artifacts under docs/wiki/**

Canonical Config Explain / Lookup Paths​

Configuration and schema-aware docs must be explainable through deterministic commands:

python scripts/docs/generate_reference_docs.py
python scripts/docs/check_runtime_drift.py
python scripts/docs/compute_docs_hash.py

The v1.6 plan also reserves the contract for higher-level lookups such as:

  • helpifyr schema lookup <tool>.<path>
  • helpifyr config explain <tool>.<path>

Drift-Sensitive Config Areas​

Configuration drift matters most for:

  • OpenAPI / generated reference truth
  • event-model sources and capability projections
  • docs manifests and page-family skeletons
  • redirect/search/rollback state
  • runtime verification and host readback hooks

Required Docs Execution Hooks​

Docs execution integration depends on these commands staying valid:

python scripts/docs/validate_execution_links.py
python scripts/docs/check_capability_docs_mapping.py
python scripts/docs/prepare_docs_rollback_bundle.py --check

Secrets Handling​

  • secrets must never be committed into docs artifacts
  • .env values are execution-only and never documentation truth
  • evidence outputs must redact sensitive values

Compatibility and Change Impact​

Any change to:

  • API
  • config
  • CLI
  • event model
  • migration behavior
  • security behavior

must carry Docs Impact classification and update docs truth where required.

  • Install
  • Operations
  • Security (docs/SECURITY.md)
  • Docs Platform v1.6 (docs/contracts/HELPIFYR_DOCS_PLATFORM_V1_6.md)

License​