Skip to main content

Documentation Index

Documentation Map​

Documentation Index

Tool / Contract Summary​

This index is the canonical documentation entry point for jhf-beam. Use it as the Wiki.js import root for repository-owned safety, contract, and verification documentation.

Business Value​

Beam documentation defines how change safety is proven, not just declared. It keeps responsibilities explicit across contracts, runtime ownership, and verification evidence.

Current Verified State​

  • Certification standards are maintained under docs/testing/.
  • Repo-level and host-bound verify paths are maintained under maintenance/ and ops/host/.
  • Fabric truth consumption is documented as read-only.
  • Feature registry for QA automation is maintained in docs/MODULE_FEATURES.md.

Canonical Docs​

Contracts​

  • Contracts and Fabric Consumption (docs/CONTRACTS_AND_FABRIC_CONSUMPTION.md)
  • Artifact Contract (docs/ARTIFACT_CONTRACT.md)
  • Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
  • Production Certification Standard (docs/testing/JHF_BEAM_PRODUCTION_CERTIFICATION_STANDARD.md)
  • Stack Runtime Contract (docs/testing/JHF_BEAM_STACK_RUNTIME_CONTRACT.md)
  • ACP Wave-4 Closure Standard (docs/testing/STANDARD_AGENT_CAPABILITY_WAVE_4_CLOSURE.md)

Operational Docs​

  • Operations
  • Deployment Verify Ops (docs/DEPLOYMENT_VERIFY_OPS.md)
  • Security (docs/SECURITY.md)
  • Release Checklist (docs/RELEASE_CHECKLIST.md)

Runbooks​

  • Runbook
  • Upgrade Operator Guide (docs/UPGRADE_OPERATOR_GUIDE.md)
  • Upgrade Decision Tree (docs/UPGRADE_DECISION_TREE.md)
  • Known Upgrade Breakpoints (docs/KNOWN_UPGRADE_BREAKPOINTS.md)

Evidence and Historical​

  • Docs Inventory Drift Review (docs/DOCS_INVENTORY_DRIFT_REVIEW.md)
  • Evidence and live readback under maintenance/evidence/ stay inventory-visible but conservative (link_only or never) and are not mirrored as canonical wiki truth.
  • Historical work slices remain under docs/issues/ and stay out of the canonical docs spine.

Plans​

  • Autonomous Backlog (docs/AUTONOMOUS_BACKLOG.md)
  • Roadmap (docs/ROADMAP.md)

Extended Reference​

  • Testing Standards (docs/testing/JHF_BEAM_PRODUCTION_CERTIFICATION_STANDARD.md)

Planned / Not in current scope​

  • No Beam-owned runtime API service documentation because Beam is not a runtime API service.
  • No local truth-authoring documentation for Fabric-owned contract families.

License​

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.