docs: fix dangling per-library CLAUDE.md references to point at AGENTS.md / CONTRIBUTING.md#128
Merged
Merged
Conversation
…NG.md The two tracked per-library agent quickstarts referenced the root CLAUDE.md and .claude/rules/, both gitignored — a dead link for anyone who clones the repo. Point them at the committed AGENTS.md and CONTRIBUTING.md instead. Also fix AGENTS.md, which described the per-library CLAUDE.md files as "local, not published" when they are in fact tracked. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Audit against the real SDK tree found inaccuracies/gaps in the two
published per-library CLAUDE.md files:
- Python: logger namespace was documented as getLogger("patter") but the
SDK uses getLogger("getpatter") everywhere — corrected. Added Plivo to
the telephony adapters, plus the carriers/, cli.py, local_config.py,
evals/engines/integrations entries, and llm/ to the public-namespace line.
- TypeScript: added Plivo to the telephony adapters, carrier-config.ts, and
llm/ to the public-namespace line.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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
The two tracked per-library agent quickstarts (
libraries/python/CLAUDE.md,libraries/typescript/CLAUDE.md) told agents: "For repo-wide rules, see the rootCLAUDE.mdand.claude/rules/." Both of those paths are gitignored — so for anyone who clones the repo (every external contributor and their AI agent), that's a dead reference pointing at files they don't have.This points them instead at the committed repo-wide guides that already exist on
main:AGENTS.mdandCONTRIBUTING.md.Changes
libraries/python/CLAUDE.md/libraries/typescript/CLAUDE.md— line 3 now links toAGENTS.md+CONTRIBUTING.md(relative../../) instead of the gitignored rootCLAUDE.md/.claude/rules/.AGENTS.md— corrected the "Where things live" note: the per-libraryCLAUDE.mdfiles are tracked/committed, not "local, not published".Breaking change?
No — documentation only.
Test plan
.md), no SDK code touched → no CHANGELOG entry required (refactor/docs exemption).Docs updates
AGENTS.md,libraries/python/CLAUDE.md,libraries/typescript/CLAUDE.md