docs: Simplify AGENTS.md/CLAUDE.md - #311
Merged
Merged
Conversation
Remove easily-stale API listings, directory trees, and usage examples from AGENTS.md files in favor of pointing to source of truth (index.ts exports, example apps). Extract the core endpoint guide into docs/adding-a-core-endpoint.md.
AGENTS.md trimming does not ship any package change, so no version bump. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 0d73cda The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Greptile flagged three inaccuracies in the new agent docs. All three check out against the source. - docs/adding-a-core-endpoint.md pointed new clients at YouVersionAPI. Every domain client composes ApiClient; YouVersionAPI is a static header helper with no base URL, timeout, or response handling. - The same file required a request and response schema per endpoint. GET methods validate params with private schemas on the client, and HighlightsClient.delete returns no body. - packages/ui/AGENTS.md called every src/components/ui/ primitive unexported. Separator and Textarea ship through the entry point. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Greptile flagged that packages/core/AGENTS.md still told contributors to reuse YouVersionAPI as a base client, contradicting the endpoint guide corrected in a0ab84b. YouVersionAPI exposes one static method, addStandardHeaders, and has no callers in src/. ApiClient owns base URL, timeout, default headers, and response handling, and every domain client takes it as a constructor argument. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
bmanquen
previously approved these changes
Aug 4, 2026
The bare frontmatter read as an accidental empty file in review. Spell out that a docs-only PR still needs a changeset and ships no version bump. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
cameronapak
force-pushed
the
claude/doctor-command-609715
branch
from
August 4, 2026 21:14
06ffa90 to
0d73cda
Compare
bmanquen
approved these changes
Aug 4, 2026
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
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.
Summary
I ran Claude Opus 5 through https://x.com/trq212/status/2080710971228918066 to simplify the AGENTS file because... LLMs are getting smarter/better, so they need less hand-holding.
The four AGENTS.md files carried directory trees, export lists, and 211 lines of usage examples that the code already shows. The cut removes about 3,000 tokens of agent context and stops those listings from going stale.
Changes
lsandpackage.jsonalready give.packages/core/AGENTS.mddrops a file list that named 14 of 25 source files and an export list that missed four exports.packages/hooks/AGENTS.mdandpackages/ui/AGENTS.mddrop 211 lines of usage examples and point atexamples/vite-reactand Storybook.docs/adding-a-core-endpoint.mdholds the endpoint workflow, which now loads only when someone adds an endpoint.Start here: change 3 — the facts that survived the two deleted sections.
Test plan
packages/core/src/holds 25 files andsrc/index.tshas 18 export statements, against the 14 files and 8 exports that the deleted list named.scriptsblock ofpackage.json.CLAUDE.mdsymlinks still resolve to theirAGENTS.md.🤖 Generated with Claude Code
Greptile Summary
The PR simplifies repository agent guidance while preserving critical package and release constraints.
ApiClient, schema requirements, environment entry points, and public UI primitives.Confidence Score: 5/5
The PR appears safe to merge.
No blocking failure remains.
Important Files Changed
ApiClient.Reviews (7): Last reviewed commit: "chore: label the empty changeset as inte..." | Re-trigger Greptile