Skip to content

This directory holds the canonical project documentation: design, reference, security, governance, testing, and lifecycle. Files are named in upper-kebab-case so they sort naturally and read like a table of contents in a directory listing.

For the doc-tree front door (where-to-start by intent), see ../README.md . For operational runbooks (day-2 procedures), see ../runbooks/ . For formal architectural decision records, see ../adr/ .

Operator entry points

  • GETTING-STARTED.md — guided ~30-minute fresh-VM walkthrough: install → run a command → apply state → browse the audit log.
  • GLOSSARY.md — terminology used throughout the project (agent, blueprint, runbook, saga, …).

Reference (auto-generated — regenerate with make docs-sync)

  • CLI-REFERENCE.md — every kscore-* binary + every subcommand. Every kscore-<name> operator binary is also reachable as kscorectl <name> via plugin dispatch.
  • CONFIGURATION-REFERENCE.md — every config key in server.yaml and agent.yaml, with type + description.
  • API-REFERENCE.md — every gRPC RPC + REST endpoint, with links to the canonical proto / OpenAPI sources.

Design + architecture

Security

The vulnerability-reporting entry point is ../../SECURITY.md at the repo root.

Governance + process

Testing + quality

Development + incident response

  • DEVELOPMENT.md — build, test, contribute. The Local Dev Topology section covers the docker-compose dev harness for ad-hoc iteration.
  • INCIDENT-RESPONSE.md — production security-incident response (compromised agent, control plane, data breach, supply chain).
  • RELEASE-INCIDENT.md — what to do when a published release reveals a critical problem (yank, fast follow-up release, public communication). Companion to ../../RELEASE-PLAYBOOK.md § 14.

Project lifecycle

  • VERSIONING.md — the v0.x → v0.5 → v1.0 release ladder + gate checklists.
  • ROADMAP.md — ranked backlog (gate-v0.5, gate-v1.0, v0.x, v1.x, v2.x+).
  • PUBLIC-LAUNCH-CHECKLIST.md — the pre-launch quality gate checklist (Phases A–G).
  • CODEBERG-SETTINGS-AUDIT.md — in-repo source of truth for the Codeberg-side repository configuration (metadata, feature toggles, merge methods, branch protection). Closes E1 of the launch checklist.

Related directories

  • ../runbooks/ — twelve operational runbooks for day-2 procedures.
  • ../adr/ — formal Architectural Decision Records + template.
  • ../../epics/ — the 19 reconstruction epics, in dependency order. Epic acceptance criteria are the authoritative v0.1.0 scope.