Skip to content

AGENTS.md holds only what a contributor's agent needs; the architecture notes move to docs/ - #380

Merged
wr merged 1 commit into
mainfrom
wells/agents-md-public
Oct 30, 2026
Merged

wr merged 1 commit into
mainfrom
wells/agents-md-public

Conversation

@wr

@wr wr commented Oct 30, 2026

Copy link
Copy Markdown
Owner

AGENTS.md is read by every contributor's coding agent, so it should hold only what any of them needs. It had grown to 80 KB of architecture notes, private ticket numbers and project history. This cuts it to about 16 KB and moves the architecture into public docs.

What changed

  • AGENTS.md (80 KB → 16 KB): what the project is, where the docs are, the layout, commands, deploy steps, a short architecture, the rules that must not break, and licensing. The Source of truth and Writing sections are unchanged.
  • New docs, mostly the old notes as they were, ticket numbers removed:
    • docs/architecture.md: the server's model (panels, the tick, frames, pictures and outputs, push, viewers, the drawn store, adding frames, firmware updates, sources, the webapp).
    • docs/rendering.md: the render pipeline, the collage, AI generation and the spend gate, the plate library, the colour panel, dithering, the framebuffer format.
    • docs/folios.md: the plate crosswalks and how each book's scans are cut.
    • docs/hosted.md: Featherframe Cloud.
    • docs/firmware.md: the firmware, with the build note that platformio.ini pointed to.
  • The old notes' "a second panel is being ported" and "one server drives one panel" were out of date; the Panels section now says what the code does (each frame is drawn for the panel it reports).
  • firmware/platformio.ini and docs/plate-sources.md now point to the new docs instead of AGENTS.md.

Verified

  • Every paragraph of the old file is in the new AGENTS.md, one of the new docs, or the maintainer's private notes (history, dates, and which ticket built what).
  • A second model reviewed the new file against the old one for lost rules and for anything personal left in public files.
  • Paths, function names, Make targets, PlatformIO envs and test files named in AGENTS.md were checked against the code.
  • No code changed.

@wr
wr merged commit 7bf61e4 into main Oct 30, 2026
6 checks passed
@wr
wr deleted the wells/agents-md-public branch October 30, 2026 03:32
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