Skip to content

docs: per-command and per-package guides under docs/{commands,packages} - #212

Merged
gmoigneu merged 1 commit into
mainfrom
docs/commands-and-packages
May 3, 2026
Merged

docs: per-command and per-package guides under docs/{commands,packages}#212
gmoigneu merged 1 commit into
mainfrom
docs/commands-and-packages

Conversation

@gmoigneu

@gmoigneu gmoigneu commented May 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds two new doc subdirectories that mirror the runtime structure of gaal so a reader can navigate either by what they're trying to do (`commands/`) or by what they're trying to understand in the codebase (`packages/`).

`docs/commands/` — one page per CLI verb

`sync`, `status`, `info`, `init`, `audit`, `agents`, `doctor`, `migrate`, `schema`, `version` plus an index README. Each page covers:

`commands/sync.md` is the deepest write-up — covers planner-vs-apply, parallel repo fan-out, the skill-cache layout per OS, atomic install / merge / extract, snapshot writes, prune gating, service-mode failure cap, cancellation, and the tooling probe.

`docs/packages/` — one page per internal package

Includes the four support packages introduced by the recent reliability batch (`httpx`, `secfile`, `telemetry`, `tools`, `urlx`). Pages defer to the existing top-level pillar docs (`config.md`, `core.md`, `discover.md`) rather than duplicating them, and add:

Drift fixed in the existing top-level docs

`docs/architecture.md`:

Pillars alignment

Reviewed the existing pillars and confirmed recent work doesn't add or change pillars:

  • Config: 6 pillars (Config / Scope Policy / Schema / Validation / Platform / Template) intact.
  • Core: 2 pillars (VCS / Agent Registry) intact.
  • Discover: snapshot drift heuristic unchanged.

Recent PRs (#185-#207) are bug fixes / hardening within these pillars; package-level pages note them under "Recent fixes worth knowing".

Test plan

  • All links resolve (`grep` audit)
  • `go build ./...` and `go test ./...` pass (no code changed; sanity check)
  • Manual render of the mermaid diagrams via GitHub Markdown preview

Adds two new doc subdirectories that mirror the runtime structure of
gaal so a reader can navigate either by what they're trying to do
(commands/) or by what they're trying to understand in the codebase
(packages/).

commands/ — one page per CLI verb (sync, status, info, init, audit,
agents, doctor, migrate, schema, version) plus an index README. Each
page covers usage, exit codes, the end-to-end execution flow as a
mermaid flowchart, side effects (every path the command reads or
writes), and links to the relevant package docs. sync.md is the
deepest write-up — it covers planner-vs-apply, parallel repo fan-out,
the skill-cache layout per OS, atomic install / merge / extract,
snapshot writes, prune gating, service-mode failure cap, cancellation,
and the tooling probe.

packages/ — one page per internal package, including the four
support packages introduced by the recent reliability batch
(httpx, secfile, telemetry, tools, urlx). Pages defer to the existing
top-level pillar docs (config.md, core.md, discover.md) rather than
duplicating them, and add per-package public-API tables, dependency
graphs, recent-fix notes (PR / issue refs), and runtime flow diagrams.

Also reconciles the top-level architecture.md with main:
- Adds httpx, installscript, secfile, telemetry, tools, urlx to the
  package tree and points at the new subdirs.
- Drops the stale `--yes` flag from the migrate row (PR #185 / #141).
- Updates the repo manager paragraph to point at the new package docs
  and references #124 for the archive-update tracking.
@gmoigneu
gmoigneu merged commit 7feb26d into main May 3, 2026
6 checks passed
@gmoigneu
gmoigneu deleted the docs/commands-and-packages branch May 3, 2026 18:54
@github-actions github-actions Bot added this to the v0.2.0 milestone May 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant