Aller au contenu principal

Release Notes

Documentation Map​

Release Notes

Purpose​

This page is the canonical docs-facing release-note anchor for jhf-fabric.

It complements CHANGELOG.md by describing the public documentation and contract posture that supports:

  • version-aware publication
  • rollback readiness
  • docs consistency state tracking

Current Docs Platform Baseline​

v1.6 foundation​

  • Docusaurus is the public docs frontend
  • docs runtime drift is explicitly classified
  • execution-link validation is machine-readable
  • per-repo docs_hash and stack-wide global_docs_state are published
  • rollback bundle readiness is part of docs verification

v1.6.2 docs publisher cutover​

  • Fabric publishes one explicit docs repository registry with jhf-web as the current public publisher for https://helpifyr.com/docs/
  • helpifyr-fabric remains the canonical bundle generator plus governance owner
  • jhf-docs stays explicitly non-current and may only appear as a planned future manufacturer-docs migration target
  • Fabric publishes advisory docs quality score and recommendation-only learning-loop issue surfaces
  • Fabric publishes machine-readable scenario validation for Annual Close, Support Flow, and Campaign Flow
  • the docs plan is now persisted in docs/plans/PLAN_FABRIC_DOCS_v2.md
  • the latest live readback now returns quality-score-published 100/100 and learning-loop-ready, so the former recommendation-only refresh lane is closed as current-state truth

Source of Change Truth​

Primary change sources:

  • CHANGELOG.md
  • contracts/docs/docs_platform_contract_v1_6.json
  • docs/contracts/HELPIFYR_DOCS_PLATFORM_V1_6.md

Release Verification​

Use these commands before treating a docs release slice as ready:

python scripts/docs/verify_docs_platform_contract.py
python scripts/docs/check_docs_quality_surfaces.py
python scripts/docs/check_scenario_validation.py
python scripts/docs/compute_global_docs_state.py
python scripts/docs/prepare_docs_rollback_bundle.py --check

Rollback Reference​

Rollback must preserve:

  • prior docs contract truth
  • redirect map
  • search index
  • docs hashes
  • release-note anchors

License​