Cut AGENTS.md to what the code cannot tell an agent - #112
Merged
Conversation
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 Key Files source listing and trims the build section. Keeps the FFI knowledge the code scatters and the compiler won't teach you: the LibreSSL/OpenSSL divergences, the is_null()-before-FFI and _final null-default traps, the 'multiple possible declarations' ifdef-guard gotcha, and the C-to-Pony type mapping.
ponylang-main
added
the
discuss during sync
ponylang-main
removed
the
discuss during sync
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENTS.md was 136 lines. Unlike most repos here, its content is mostly genuine FFI knowledge the compiler won't teach and the code scatters across files — so this is a light cut, not a gut.
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 removes the Key Files source listing and the two omnipresent ifdef/use-guard demo blocks, and keeps what a cold agent can't cheaply reconstruct: the five LibreSSL/OpenSSL divergences, the is_null()-before-FFI and _final null-default traps, the exclusion-guard 'multiple possible declarations' gotcha, and the C-to-Pony type mapping. 136 to ~90 lines.