Skip to content

Fix stale and incomplete documentation#51

Merged
JAORMX merged 1 commit intomainfrom
fix/docs-audit-update
Mar 17, 2026
Merged

Fix stale and incomplete documentation#51
JAORMX merged 1 commit intomainfrom
fix/docs-audit-update

Conversation

@JAORMX
Copy link
Copy Markdown
Contributor

@JAORMX JAORMX commented Mar 17, 2026

Summary

Full documentation audit comparing all docs against the actual codebase. Fixes:

  • README.md: Agent default RAM was listed as 2 GiB, actual is 4 GiB. Non-existent --no-review flag replaced with --review
  • USER_GUIDE.md: Fixed default memory (2048 → 4096), replaced --no-review with --review, added 7 missing CLI flags (--no-save-credentials, --seed-credentials, --no-image-cache, --tmp-size, --exec, --timings), added auth list/auth clear subcommands, rewrote review section to reflect that snapshot isolation is always active
  • CLAUDE.md: Added 5 missing domain packages (credential/, egress/, git/, hostservice/, progress/), 6 missing infra packages (credential/, git/, logging/, terminal/, progress/, process/), added pkg/runtime/ layer, fixed internal/guest/ description (only homefs/ lives here; boot/mount/network/env/sshd/reaper are in go-microvm)
  • ARCHITECTURE.md: Clarified guest layer split between this repo (homefs/) and go-microvm (boot/, mount/, network/, env/, sshd/, reaper/)
  • Removed stale empty pkg/infra/ directories left over from past migration

Test plan

  • Verify all documented CLI flags match bbox --help output
  • Verify agent defaults in README match internal/infra/agent/registry.go
  • Verify pkg/infra/ removal doesn't break builds (task build)
  • Verify no Go files referenced the removed pkg/infra/ path

🤖 Generated with Claude Code

- README: Fix agent default RAM (2 GiB → 4 GiB), replace non-existent
  --no-review flag with --review
- USER_GUIDE: Fix default memory, replace --no-review with --review,
  add 7 missing CLI flags (--no-save-credentials, --seed-credentials,
  --no-image-cache, --tmp-size, --exec, --timings), add auth
  subcommands, rewrite review section to match actual behavior
- CLAUDE.md: Add 5 missing domain packages, 6 missing infra packages,
  add pkg/runtime/ layer, fix internal/guest/ description (only
  homefs/ lives here; boot/mount/network/env/sshd/reaper are in
  go-microvm)
- ARCHITECTURE.md: Clarify guest layer split between this repo and
  go-microvm
- Remove stale empty pkg/infra/ directories from past migration

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@JAORMX JAORMX merged commit 4e996fa into main Mar 17, 2026
7 checks passed
@JAORMX JAORMX deleted the fix/docs-audit-update branch March 17, 2026 09:16
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.

2 participants