docs: per-command and per-package guides under docs/{commands,packages} - #212
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Recent PRs (#185-#207) are bug fixes / hardening within these pillars; package-level pages note them under "Recent fixes worth knowing".
Test plan