Repository navigation
AGENTS.md holds only what a contributor's agent needs; the architecture notes move to docs/ - #380
Merged
Merged
Conversation
…re notes move to docs/
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.
AGENTS.mdis 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. TheSource of truthandWritingsections are unchanged.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 thatplatformio.inipointed to.firmware/platformio.inianddocs/plate-sources.mdnow point to the new docs instead ofAGENTS.md.Verified
AGENTS.md, one of the new docs, or the maintainer's private notes (history, dates, and which ticket built what).AGENTS.mdwere checked against the code.