Skip to content

docs: bring the documentation up to the shipped surface - #5

Merged
derfsss merged 2 commits into
mainfrom
develop
Sep 11, 2026
Merged

derfsss merged 2 commits into
mainfrom
develop

Conversation

@derfsss

@derfsss derfsss commented Sep 11, 2026

Copy link
Copy Markdown
Owner

Documentation-only. No code, no version change.

A full pass over the README and everything it links to, checking each document against what the code actually does rather than against itself. Verified mechanically: all 137 live tools and 59 daemon methods appear in COMMANDS.md, and every internal link and anchor across the 13 documents resolves.

Gaps closed

Ordered by what they'd cost a user:

  • z.library was never listed as a target requirement, although fs.upload compression and wb.screenshot both need it. keymap.library and graphics.library were missing too.
  • input.*, sandbox.* and wb.screenshot had no per-feature prerequisite entries. That table is the one a user reads after a NotCapable, and it didn't mention the three newest features. input.* now spells out both gates; sandbox.* covers the SandboxVM binary and the ExtMem requirement.
  • CONTRIBUTING.md said "branch from main" — the protected release branch. That is exactly why input.*: keyboard and mouse injection, disabled by default #2 arrived aimed at main and needed rebasing. It now says develop, and explains why.
  • Neither README nor USAGE mentioned wb.screenshot, and USAGE's namespace table was missing input.* and sandbox.*.
  • Daemon source layouts in BUILD.md and mcpd/README.md were two modules stale, the binary size ~100 KiB out, and the install-script list missing the two input scripts.
  • No quick start. The README described the system well but never showed the three commands that get someone to a working session.

Newly documented behaviours

Both cost real debugging time and neither was written down anywhere public:

  • The AmigaOS kernel debug buffer does not wrap. Once full it stops accepting entries, so on a machine with a verbose driver sys.debug_ring can be blind to everything logged after boot. Compare raw_size across two calls to tell "full" from "quiet"; serial.* is unaffected.
  • While a board is powered off, only power.on / power.off are safe to send to the MCU. Other shell commands can leave a cold MCU unresponsive until mains power is cut.

Framing

Shifted from how the project got here to what it does: supported targets became a status matrix, "Status" became "Requirements", and BUILD's source-of-truth note now points at --list-tools and proto.capabilities rather than describing the docs as a record of intent.

🤖 Generated with Claude Code

https://claude.ai/code/session_01VF4wwBXaKNK2Y2N5sYtt71

derfsss and others added 2 commits September 11, 2026 08:13
Full pass over the README and everything it links to, checking each
document against what the code actually does rather than against
itself. Every one of the 137 live tools and 59 daemon methods is now
verified present in COMMANDS.md, and every internal link and anchor
resolves.

Gaps closed, in rough order of how much they'd cost a user:

- **`z.library` was never listed as a target requirement**, though
  `fs.upload` compression and `wb.screenshot` both need it. Neither
  were `keymap.library` or `graphics.library`.
- **`input.*`, `sandbox.*` and `wb.screenshot` had no per-feature
  prerequisite entries**, so the one table a user consults after a
  `NotCapable` didn't mention the three newest features. `input.*`
  now spells out both gates, `sandbox.*` the SandboxVM binary and the
  ExtMem requirement.
- **CONTRIBUTING said "branch from `main`"** — the release branch.
  That is why the contributed PR arrived aimed at a protected branch
  and had to be rebased. It now says `develop`, and why.
- **Neither README nor USAGE mentioned `wb.screenshot` at all**, and
  the namespace table in USAGE was missing `input.*` and `sandbox.*`.
- The daemon source layouts in BUILD.md and mcpd/README.md were two
  modules out of date, the binary size ~100 KiB out, and the install
  scripts list missing the two input ones.
- No quick start. The README described the system well but never
  showed the three commands that get someone to a working session.

Also documented, because both cost real debugging time: the AmigaOS
kernel debug buffer does not wrap, so on a machine with a chatty
driver `sys.debug_ring` can be blind to everything after boot
(compare `raw_size` across two calls); and while a board is powered
off, only `power.on` / `power.off` are safe to send to the MCU --
anything else can wedge it until mains power is cut.

Framing throughout is what the thing does, not how it came to be:
supported targets became a status matrix, the "Status" section became
"Requirements", and BUILD's source-of-truth note now points at
`--list-tools` and `proto.capabilities` instead of describing the
docs as a record of intent.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VF4wwBXaKNK2Y2N5sYtt71
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VF4wwBXaKNK2Y2N5sYtt71
@derfsss
derfsss merged commit a0a0393 into main Sep 11, 2026
8 checks passed
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