README.md

fkst-packages docs

Docs are split by audience:

• user/ — for operators installing and running the system in a host repo: onboarding, install, configuration, operation. Read these to use fkst.

  • user/downstream-customization-guide.md — choose the downstream shape, customization surface, and conformance gate for specialized package or host repos.
  • user/new-package-repo-bootstrap.md — bootstrap a new fkst package/host repo scaffold.
  • user/github-devloop-dogfood-topology.md — reproduce the per-device github-devloop dogfood branch topology on another machine.
  • user/control-planes-and-host-repo-composition.md — package, host-repository, and deployment ownership; host composition via source pins plus .fkst/local-packages/; and host-repo conformance without copied infrastructure.
  • user/global-host-profiles.md — XDG-style host-local environment profiles for repository checks and tests without repo-local machine paths.
  • user/github-app-permissions.md — GitHub App repository and organization permissions, derived from the enforced gh/git adapter egress inventory.

• dev/ — for contributors developing the system: design specs, architecture, and methodology. Read these to change fkst.

  • dev/devloop-design.md — github-devloop state machine and design.
  • dev/consensus-converge-redesign.md — consensus converge/reconcile redesign.
  • dev/harness-construction-methodology.md — harness-first methodology.
  • dev/observability-legibility.md — local health verdict and board classification contract.
  • dev/scaffold-install-upgrade-design.md — host-repo scaffold install + upgrade + package-reference update design.

The authoritative engine↔package contract lives in fkst-substrate's docs/package-repo-contract.md; repo conventions and commands are in this repo's top-level README.md.

⟦AI:FKST⟧