Skip to content

docs: AGENTS.md keeps what an agent needs before it acts, and points to the rest - #168

Merged
CaffeinatedCoder merged 1 commit into
release/2.3.0from
docs/agents-md-trim
Oct 29, 2026
Merged

CaffeinatedCoder merged 1 commit into
release/2.3.0from
docs/agents-md-trim

Conversation

@CaffeinatedCoder

Copy link
Copy Markdown
Owner

Closes #167

Problem

AGENTS.md loads into every agent session in this repository: 22,230 characters, about 6k tokens, most of the roughly 10k tokens of memory files a session starts with. Five sections repeated what another file holds, or detailed what an agent needs only at one moment.

Change

Section Before After Where the rest lives
Finding code 3,693 chars 2,310 design/code-graph.md (new, linked from design/plan.md): the graph's measured gaps from 2026-10-13, and refreshing it
Commands 3,691 2,825 the guard's own refusal message; decisions 92 and 105
Issues 1,808 1,032 CONTRIBUTING's "Issues and labels" and "Pull requests"
Workflow 3,223 2,576 step 7's mechanics: test/oracles/README.md
Releasing 1,210 608 CONTRIBUTING's "Releasing", step 1

Each section keeps what an agent must know before it acts:

  • the graph leads and the source decides, and an empty result proves nothing;
  • what the verdict prints and what the guard refuses;
  • sub-issues, branch names and closing an issue by hand after a release-branch merge;
  • a promise gets a claim or a waiver;
  • the arm64 TYPEKIT_MSSQL_IMAGE, and never deleting a seed or reading an ERROR as caught.

"Rules that are easy to break" is unchanged, and so is every heading another document cites: decision 93 cites "Finding code".

AGENTS.md goes from 22,230 to 17,956 characters, about 1.1k tokens less per session start. That's about half the 2–2.5k #167 estimated; the rest of those sections is what an agent needs up front.

Tests

  • CodoMetis.TypeKit.Conventions.Tests: 2,002 passed.
  • docs-query check: 0 problems in 854 links.
  • Each dropped sentence was checked against the file it now points to.

🤖 Generated with Claude Code

…to the rest

AGENTS.md loads into every agent session. Five sections repeated what another
file holds or detailed what an agent needs only at one moment:

- Finding code: the graph's measured gaps move to design/code-graph.md (new,
  linked from design/plan.md); AGENTS.md keeps the rule and the gaps in one line.
- Commands: the BuildVerdict, BashGuard and session-start paragraph shrinks to
  what the verdict prints and what the guard refuses.
- Issues: the label legend, epics and PR checks are CONTRIBUTING's; what stays
  is what trips agents here.
- Workflow step 7: the oracle-kit mechanics are test/oracles/README.md's.
- Releasing: CONTRIBUTING's "Releasing" holds the steps; the seeds, the
  arm64 image and the never-delete-a-seed rule stay.

"Rules that are easy to break" is unchanged, and so is every heading another
document cites. 22,230 to 17,956 characters, about 1.1k tokens less per
session start. Conventions tests pass (2,002) and docs-query check is clean.

Refs #167

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@CaffeinatedCoder CaffeinatedCoder added this to the 2.3.0 milestone Oct 29, 2026
@CaffeinatedCoder CaffeinatedCoder added documentation Improvements or additions to documentation area/tooling The repository's tools: prober, verdict, guard, docs-query, smoke test labels Oct 29, 2026
@CaffeinatedCoder
CaffeinatedCoder merged commit d64a545 into release/2.3.0 Oct 29, 2026
14 checks passed
@CaffeinatedCoder
CaffeinatedCoder deleted the docs/agents-md-trim branch October 29, 2026 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tooling The repository's tools: prober, verdict, guard, docs-query, smoke test documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant