docs: AGENTS.md agent-maintenance docs system - #33
Merged
Conversation
Root AGENTS.md as single source of truth (commands, conventions, repo map, cross-cutting gotchas, PR/commit rules), a thin CLAUDE.md that @-imports it (no duplicated facts), and an additive packages/core/AGENTS.md mapping the engine subsystems and its load-bearing render/store invariants with file:line references. Grounded in the real code and existing docs; links to docs/ARCHITECTURE.md et al. rather than restating them.
AGENTS.md is tool-agnostic; the no-AI-attribution trailer rule is a Claude-only preference already held in global memory, so it doesn't belong in the repo doc.
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
1 participant
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.
Adds the "core set" of the agent-docs system described in
ai-agent-docs-guide.md, so coding agents get enough repo context without bloating every session.What's included
AGENTS.md(root, ~100 lines) — single source of truth: commands, biome/TS conventions that differ from defaults, repo map, cross-cutting behavioral gotchas, PR/commit rules.CLAUDE.md(thin) — just@AGENTS.md+ a couple of Claude-only notes. No duplicated facts, so nothing can drift.packages/core/AGENTS.md(additive) — engine subsystem map + the load-bearingrender//store/invariants, each withfile:line(sorted-(z,id) paint cache, save/restore elision, integer edge versions, font epoch,undefined→null, z watermarks, removeNode cascade).Principles followed
docs/ARCHITECTURE.md/IMPLEMENTATION.md/IMPROVEMENTS.md, never restated.Not included (deliberate, follow-up if wanted)
Per-package files for
react/sync-broadcast,docs/adr/, path-scoped rules, and enforcement hooks. The referenceai-agent-docs-guide.mdis intentionally left uncommitted.