Skip to content

Cut AGENTS.md to what the code cannot tell an agent#133

Merged
SeanTAllen merged 1 commit into
mainfrom
agents-md-cleanup
Jul 12, 2026
Merged

Cut AGENTS.md to what the code cannot tell an agent#133
SeanTAllen merged 1 commit into
mainfrom
agents-md-cleanup

Conversation

@SeanTAllen

Copy link
Copy Markdown
Member

AGENTS.md was 462 lines, most of it a second copy of what the repository already states. About 300 lines were a GitHub-endpoint coverage table marking each endpoint implemented-or-missing — the implemented half rots on every added operation, and its upkeep was written into the old 'keep CLAUDE.md in sync' convention. The rest was a source-tree listing and a full enumeration of the object convenience API, both already covered by examples/ (including the -oo variants) and the package docstring.

Applying the pony-agents-md principle — a line earns its place only if reading it here is cheaper and truer than learning it from the repo — this keeps the ssl=-required build commands, the request/response picture, and a few conventions. 462 to ~50 lines.

Applies the pony-agents-md principle: a line earns its place only if
reading it here is cheaper and truer than learning it from the repo.
Removes the source-tree listing, the OO-API method enumeration (examples/
compiles, including the -oo variants), and the ~300-line endpoint
coverage table — a second copy of what is implemented that rots on every
added operation, and whose upkeep the old 'keep CLAUDE.md in sync'
convention institutionalized. Keeps the commands, the request/response
picture, and the conventions.
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Jul 12, 2026
@SeanTAllen
SeanTAllen merged commit 693267d into main Jul 12, 2026
7 checks passed
@SeanTAllen
SeanTAllen deleted the agents-md-cleanup branch July 12, 2026 21:56
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Jul 12, 2026
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