Skip to content

docs: Simplify AGENTS.md/CLAUDE.md - #311

Merged
cameronapak merged 7 commits into
mainfrom
claude/doctor-command-609715
Aug 4, 2026
Merged

docs: Simplify AGENTS.md/CLAUDE.md#311
cameronapak merged 7 commits into
mainfrom
claude/doctor-command-609715

Conversation

@cameronapak

@cameronapak cameronapak commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

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

  1. Root AGENTS.md drops the structure tree, the command lists, and the stack facts that ls and package.json already give.
  2. Root AGENTS.md states each rule once, because KEY PATTERNS and ANTI-PATTERNS repeated the gotchas below them.
  3. The five unique facts inside those two deleted sections moved into CRITICAL GOTCHAS.
  4. packages/core/AGENTS.md drops a file list that named 14 of 25 source files and an export list that missed four exports.
  5. packages/hooks/AGENTS.md and packages/ui/AGENTS.md drop 211 lines of usage examples and point at examples/vite-react and Storybook.
  6. New docs/adding-a-core-endpoint.md holds 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

  • Confirmed packages/core/src/ holds 25 files and src/index.ts has 18 export statements, against the 14 files and 8 exports that the deleted list named.
  • Confirmed every deleted command exists in the scripts block of package.json.
  • Confirmed all four CLAUDE.md symlinks still resolve to their AGENTS.md.
  • No code changed, so no test suite ran.
  • Needs manual check: whether any deleted line held a fact that you rely on. The diff shows every removed block.

🤖 Generated with Claude Code

Greptile Summary

The PR simplifies repository agent guidance while preserving critical package and release constraints.

  • Extracts the core endpoint workflow into a focused guide.
  • Replaces stale file, export, command, and example listings with authoritative code references.
  • Corrects and aligns guidance around ApiClient, schema requirements, environment entry points, and public UI primitives.
  • Includes an intentional empty changeset for the documentation-only update.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/adding-a-core-endpoint.md Adds a focused endpoint workflow using the correct transport abstraction and wire-shape-dependent schema guidance.
packages/core/AGENTS.md Simplifies core guidance and consistently directs new domain clients to compose ApiClient.
packages/hooks/AGENTS.md Replaces stale usage examples with type-checked example and source references while retaining package-specific testing guidance.
packages/ui/AGENTS.md Simplifies UI guidance while accurately distinguishing internal primitives from the two publicly exported exceptions.
AGENTS.md Consolidates repository-wide architecture, release, build, and package-boundary guidance without changing runtime code.
.changeset/lucky-facts-design.md Adds the required intentional empty changeset for a documentation-only update.

Reviews (7): Last reviewed commit: "chore: label the empty changeset as inte..." | Re-trigger Greptile

cameronapak and others added 2 commits August 4, 2026 06:10
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-bot

changeset-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0d73cda

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

Comment thread docs/adding-a-core-endpoint.md Outdated
Comment thread docs/adding-a-core-endpoint.md Outdated
Comment thread packages/ui/AGENTS.md Outdated
@cameronapak cameronapak self-assigned this Aug 4, 2026
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>
@cameronapak cameronapak changed the title docs: AGENTS.md files point at the source instead of copying it docs: Simplify AGENTS.md/CLAUDE.md Aug 4, 2026
Comment thread docs/adding-a-core-endpoint.md
cameronapak and others added 2 commits August 4, 2026 09:16
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
bmanquen previously approved these changes Aug 4, 2026
Comment thread .changeset/lucky-facts-design.md
cameronapak and others added 2 commits August 4, 2026 16:13
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
cameronapak force-pushed the claude/doctor-command-609715 branch from 06ffa90 to 0d73cda Compare August 4, 2026 21:14
@cameronapak
cameronapak merged commit 49ec0bd into main Aug 4, 2026
14 checks passed
@cameronapak
cameronapak deleted the claude/doctor-command-609715 branch August 4, 2026 21:20
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