Make AGENTS.md smaller #30

Closed
opened 2026-10-14 16:38:31 +00:00 by Syndria98 · 3 comments
Owner

Just summarize it with the most relevant info so other agents don't get overwelmed

Just summarize it with the most relevant info so other agents don't get overwelmed
Syndria98 added the ai-ready label 2026-10-14 16:38:31 +00:00
Agent added the working label 2026-10-14 17:01:03 +00:00
Collaborator

Now I have an accurate picture. Writing the condensed AGENTS.md:

Now I have an accurate picture. Writing the condensed `AGENTS.md`:
Collaborator

Done. AGENTS.md is now a compact orientation map instead of an exhaustive dump.

What changed (AGENTS.md only, 591 → 224 lines, 39 KB → 18 KB):

  • Cut the parts an agent can read from the code in seconds: the full endpoint-by-endpoint API reference (now one line per resource listing just the route names and the non-obvious bits), the verbatim model field tables (now one line per model with only the fields that matter), the directory tree listings, the full service export tables, and the worked Vue/widget_map code samples.
  • Kept what is expensive to rediscover: the auth chain order in src/index.js (routes mounted before/after checkAuth), the always-200 {status, msg} envelope with i18n keys, the duplicated-per-router userOwnsCampaign convention, model relationships and foundryActorId/foundryItemId/foundryNames identity rules, the window-system contract and the DOM ids that must not be renamed, the mitt event list (including the close-note vs delete-note trap), --color-*/i18n "add to all three locales" rules, and the recipes.
  • Verified every statement against the current code while summarising, so the stale drift in the old file is gone rather than preserved: the service link/sync flow is now described as the generic /api/link start → authorize screen → pickup pairing used by Foundry, Discord and Obsidian (the old foundry/link/complete wording no longer matches routes/service-link.js), discord-bot/ is listed as an app (it is in npm run dev and docker-compose.yml), the test list matches tests/, and the landmine list dropped the items that have since been fixed (orphan note-created/note-renamed/folder-saved events are wired now, Note.vue unmounts widgets, SetShowContent is used by TopBar). The remaining landmines were re-checked: the setupCode ReferenceError in /user/register, the missing ownership check on /note/delete, the hardcoded JWT secret, useEmitter.ts, localhost-only CORS, the Windows.js caching/listener/ClearAll quirks, and the stale PM2 config.

No code or test changes were needed — documentation only, and nothing else in the tree was touched.

Done. `AGENTS.md` is now a compact orientation map instead of an exhaustive dump. **What changed** (`AGENTS.md` only, 591 → 224 lines, 39 KB → 18 KB): - **Cut the parts an agent can read from the code in seconds**: the full endpoint-by-endpoint API reference (now one line per resource listing just the route names and the non-obvious bits), the verbatim model field tables (now one line per model with only the fields that matter), the directory tree listings, the full service export tables, and the worked Vue/`widget_map` code samples. - **Kept what is expensive to rediscover**: the auth chain order in `src/index.js` (routes mounted before/after `checkAuth`), the always-200 `{status, msg}` envelope with i18n keys, the duplicated-per-router `userOwnsCampaign` convention, model relationships and `foundryActorId`/`foundryItemId`/`foundryNames` identity rules, the window-system contract and the DOM ids that must not be renamed, the mitt event list (including the `close-note` vs `delete-note` trap), `--color-*`/i18n "add to all three locales" rules, and the recipes. - **Verified every statement against the current code while summarising**, so the stale drift in the old file is gone rather than preserved: the service link/sync flow is now described as the generic `/api/link` start → authorize screen → pickup pairing used by Foundry, Discord and Obsidian (the old `foundry/link/complete` wording no longer matches `routes/service-link.js`), `discord-bot/` is listed as an app (it is in `npm run dev` and `docker-compose.yml`), the test list matches `tests/`, and the landmine list dropped the items that have since been fixed (orphan `note-created`/`note-renamed`/`folder-saved` events are wired now, `Note.vue` unmounts widgets, `SetShowContent` is used by `TopBar`). The remaining landmines were re-checked: the `setupCode` ReferenceError in `/user/register`, the missing ownership check on `/note/delete`, the hardcoded JWT secret, `useEmitter.ts`, localhost-only CORS, the `Windows.js` caching/listener/`ClearAll` quirks, and the stale PM2 config. No code or test changes were needed — documentation only, and nothing else in the tree was touched.
Collaborator

Implementation is ready for review: #32

Implementation is ready for review: https://git.aranroig.com/Syndria98/dragonroll/pulls/32
Agent added help wanted and removed working labels 2026-10-14 17:07:29 +00:00
Sign in to join this conversation.
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Syndria98/dragonroll#30