Skip to content

docs: slim AGENTS.md and move parameter handling to docs/ - #3046

Merged
mroderick merged 2 commits into
masterfrom
docs/slim-agents-md
Oct 18, 2026
Merged

mroderick merged 2 commits into
masterfrom
docs/slim-agents-md

Conversation

@mroderick

@mroderick mroderick commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

AGENTS.md loads in full for every planner session (12.9 KB). Parts of it repeat what the global agent config already says, cover tools that are not installed, or are procedures read only when a specific task comes up.

Change

  • Move the parameter-handling sections to docs/parameter-handling.md, unchanged. Keep one inline warning: params.expect does not work with accepts_nested_attributes_for, because that trap is what controller work hits first.
  • Collapse Development Workflow and Branching Strategy into a single block. The never-push rule lives in the global agent config; the local file keeps the branch steps.
  • Condense Core Domain Concepts to a bullet list and drop the ASCII association diagram. app/models/README.md holds the full model; both sections now point at it.
  • Remove Docker Setup (Not Used): the heading says it is not used.
  • Remove the For planning agents block: the layered-rails skill is not installed anywhere pi scans.
  • Mention the project environment on the single-test line, with mise as one option among others.

Net: 12,867 B to 9,547 B, about 830 tokens per planner session.

Review notes

  • The moved parameter-handling text should be verbatim apart from the heading levels (### to ##).
  • Check that dropping the association diagram is acceptable given app/models/README.md covers it.
  • docs/parameter-handling.md is a new committed doc; nothing in it is environment-specific.

@mroderick
mroderick force-pushed the docs/slim-agents-md branch from 81a0ed1 to 627b5d5 Compare October 18, 2026 10:57
Always-on instructions cost 3.3 KB per planner session; the patterns
inside are read only when writing controller params.

- Move the parameter-handling sections verbatim to
  docs/parameter-handling.md; keep the expect-vs-nested-attributes trap
  inline, because it is what agents hit first
- Collapse Development Workflow and Branching Strategy into a single
  self-contained block
- Condense Core Domain Concepts and drop the association diagram; both
  point at app/models/README.md for the full model
- Remove the unused Docker section and the layered-rails block; that
  skill is not installed anywhere pi scans
- Note on the single-test line that a project environment must be
  loaded; mise is one option among others
@mroderick
mroderick force-pushed the docs/slim-agents-md branch from 627b5d5 to 3d7c6dc Compare October 18, 2026 11:08
@mroderick
mroderick marked this pull request as ready for review October 18, 2026 11:12
@mroderick
mroderick merged commit 363f0d8 into master Oct 18, 2026
10 checks passed
@mroderick
mroderick deleted the docs/slim-agents-md branch October 18, 2026 11:15
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