Skip to main content

Install

Documentation Map​

Install

Purpose​

This page is the canonical install surface for jhf-fabric. It exists to make the docs executable:

  • local contributors can bootstrap the repo without guessing
  • operators can validate prerequisite state before deployment
  • docs/runtime drift can be checked immediately after installation

Prerequisites​

  • Python 3.12
  • pip
  • Docker and Docker Compose for stack validation paths
  • access to C:/CodexTest/ when operating inside the Helpifyr multi-repo workspace

Local Bootstrap​

  1. Install the package and dev dependencies:
python -m pip install --upgrade pip
pip install ".[dev]"
  1. Validate the repo-local docs contract:
python scripts/docs/validate_docs_contract.py --manifest docs/docs.manifest.yaml
  1. Validate the repo docs skeleton:
python scripts/docs/validate_repo_docs_skeleton.py --repo C:\CodexTest\helpifyr-fabric

Runtime and API Bootstrap​

Run the application locally:

$env:PYTHONPATH="src"
uvicorn helpifyr_fabric.api.app:app --reload

Then verify the docs execution surfaces:

python scripts/docs/validate_execution_links.py
python scripts/docs/check_runtime_drift.py
python scripts/docs/compute_global_docs_state.py

Docusaurus / Public Docs Foundation​

The public docs target is Docusaurus, not Wiki.js.

  • repo-local docs stay the source of truth
  • Fabric aggregates machine-readable docs state
  • generated docs artifacts must remain rollback-capable

Post-Install Verify​

Minimum post-install verification:

python scripts/docs/verify_docs_platform_contract.py
python scripts/docs/check_docs_coverage.py
python scripts/docs/prepare_docs_rollback_bundle.py --check

Failure Conditions​

Installation is not complete if:

  • the docs platform contract does not verify
  • execution-link validation is red
  • runtime drift is detected without an issue trail
  • rollback bundle generation is partial

License​