Skip to content

Latest commit

 

History

History
81 lines (70 loc) · 5 KB

README.md

File metadata and controls

81 lines (70 loc) · 5 KB

Documentation

This directory is the canonical narrative documentation for Hyperfinite. Documentation describes implemented repository behavior and explicit deployment prerequisites; it does not grant authority or substitute for live evidence.

Start here

Reader Recommended path
Executive sponsor Executive summary → Customer FAQ → Evaluation guide
Evaluation lead Evaluation guide → Approval tickets → Customer administrator
Architecture reviewer Architecture overview → Distribution boundary → Lifecycle → Control Kernel
Demo operator Demo portfolio → Operator runbook → Simulation
Customer administrator Customer administrator → Project setup → Deployment prerequisites → Administrator handoff
Security reviewer Threat model → Control matrix → Secrets and identity
Operations/support owner Observability → Incident response → Recovery → Support
Contributor Contributing → Source map → Tests
Release or legal reviewer Release evidence → Open-source readiness → Reuse policy

Documentation map

  • Architecture: authority, lifecycle, contracts, adapters, Domain Packs, packaging, and demo integration.
  • Distribution boundary: supported repository/customer-starter entry points and unsupported SDK, CLI, service, deployment, and live-effect consumption models.
  • Architecture decisions: accepted and proposed design decisions, with their current status.
  • Demos: the four demo journeys and portfolio-level simulation, observability, setup, and activation guidance.
  • Runtime: Copilot/Agentic Workflow controls, demo runtime, evidence, cost, and monitoring.
  • Security: threat model, control coverage, credential boundaries, GHAS, and administrator permissions.
  • Runbooks: Project planning, activation, deployment, customer approvals, incident response, recovery, and installation.
  • Governance: capability lifecycle and open-source readiness.
  • Provenance: source inventory and reuse policy.
  • Release: deterministic local evidence and the no-go release checklist.
  • Compatibility: Hyperfinite product/technical identity boundary plus tested Node, npm, Git, GitHub CLI, gh-aw, Copilot CLI, and platform versions.

Status language

Documentation uses these terms consistently:

  • Implemented means code or data exists in this repository and is covered by deterministic validation.
  • Hermetic means exercised with local Git and injected or fake ports; it does not imply a deployed network or credential boundary.
  • Disabled by default means configuration does not authorize live invocation or mutation.
  • Undeployed prerequisite means an interface is implemented but the independent service, key custody, conditional store, or administrator configuration is absent.
  • Unsupported means the repository intentionally provides no authority or operation for that behavior.

Documentation rules

  1. Preserve the authority order: lifecycle graph, Work Accord and Phase Contracts, policy compiler and Capability Registry, Control Kernel, trusted adapter, Single Writer, then model output.
  2. Describe GitHub Projects as projections, never authority.
  3. Distinguish repository evidence from live service evidence and fixture assertions from telemetry.
  4. Never imply that a model can select a target, route, capability, credential, retry, effect, approval, or merge.
  5. Link to the authoritative contract or runbook instead of duplicating mutable values.
  6. Update a changed contract's schema, architecture decision, security control, and deterministic tests together.
  7. Preserve LICENSE byte-for-byte and leave legal or publication decisions to authorized humans.

Local Markdown links are expected to resolve within the repository. Generated Agentic Workflow locks are compiler-owned and are not narrative documentation.