Skip to content

chore: move the engine and views detail into nested AGENTS.md files - #143

Merged
lcottercertinia merged 1 commit into
mainfrom
chore/nested-agents-md
Oct 16, 2026
Merged

lcottercertinia merged 1 commit into
mainfrom
chore/nested-agents-md

Conversation

@lukecotter

Copy link
Copy Markdown
Collaborator

📝 Overview

The root AGENTS.md held one long paragraph with a sentence for each module, so each agent read all of it. This PR moves the engine and views detail into nested files, which an agent loads when it works in that folder. It also makes the wording shorter. No fact is removed.

🛠️ Changes

  • Root AGENTS.md: 205 → 159 lines, 2,147 → 1,560 words. src/ is one short bullet per folder. engine/ and views/ point to their own file.
  • New src/engine/AGENTS.md: one line per file, and the Rollups section, moved from the root.
  • New src/views/AGENTS.md: one line per file.
  • src/engine/CLAUDE.md and src/views/CLAUDE.md import their AGENTS.md, as benchmarks/CLAUDE.md does.
  • These stay in the root, because they apply to more than one folder: the V8 object-layout rule, "event ids start at 1", Limits and Gotchas. The id and startTimestamp line moves from Rollups to Gotchas.

Check: all 187 code names in the old file are in the new files.

Claude Code loads a nested CLAUDE.md when it reads a file in that folder. Other tools can load only the AGENTS.md files from the root to their working directory. benchmarks/ works the same way.

🧩 Type of change

  • 🐛 Bug fix — fixes an issue
  • ✨ Feature — adds new functionality
  • ♻️ Refactor — no behaviour change
  • ⚡ Performance
  • 📝 Docs
  • 🔧 Chore — tooling, CI, deps
  • 💥 Breaking change

🔗 Related issues

None.

✅ Checklist

  • Tests added/updated
  • pnpm run ci passes locally
  • Changeset added (pnpm changeset) if this affects the published package
  • Docs updated if behaviour or the public API changed

The root AGENTS.md held one paragraph with a sentence for each module.
Each folder now has a short list in the root. The engine and views
files are listed in their own AGENTS.md, with the Rollups section in
the engine file. Each nested file has a CLAUDE.md that imports it, as
benchmarks/ does. The wording is shorter; no fact is removed.
@codspeed

codspeed Bot commented Oct 16, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 6 untouched benchmarks


Comparing chore/nested-agents-md (1be0936) with main (df7726f)

Open in CodSpeed

@lcottercertinia
lcottercertinia merged commit 500aeb0 into main Oct 16, 2026
10 checks passed
@lcottercertinia
lcottercertinia deleted the chore/nested-agents-md branch October 16, 2026 17: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.

2 participants