Skip to content

Commit fd72674

Browse files
docs: fix dangling per-library CLAUDE.md references to point at AGENTS.md / CONTRIBUTING.md (#128)
* docs: point per-library CLAUDE.md to committed AGENTS.md / CONTRIBUTING.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> * docs(claude): correct + complete the per-library agent quickstarts 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> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent dee7610 commit fd72674

3 files changed

Lines changed: 17 additions & 12 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ docs/ Mintlify docs site
5959
scripts/pr-validate.sh Local mirror of PR-blocking CI
6060
```
6161

62-
Per-library quickstarts: `libraries/python/CLAUDE.md` and
63-
`libraries/typescript/CLAUDE.md` (local, not published — but worth reading if
64-
present in your checkout).
62+
Per-library quickstarts (committed alongside each SDK):
63+
`libraries/python/CLAUDE.md` and `libraries/typescript/CLAUDE.md` — read the one
64+
for the SDK you're touching.
6565

6666
## Commits & PRs
6767

libraries/python/CLAUDE.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python SDK — agent quickstart
22

3-
This file is the per-library guide for AI agents working in `libraries/python/`. For repo-wide rules, see the root `CLAUDE.md` and `.claude/rules/`.
3+
This file is the per-library guide for AI agents working in `libraries/python/`. For repo-wide rules, see [`AGENTS.md`](../../AGENTS.md) and [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
44

55
## Layout
66

@@ -14,19 +14,23 @@ libraries/python/
1414
└── getpatter/ # the published package (`pip install getpatter`)
1515
├── __init__.py
1616
├── client.py # Patter entry point
17+
├── cli.py # `getpatter` console-script entry point
18+
├── local_config.py # LocalOptions + local-mode config
1719
├── models.py # public dataclasses (frozen=True)
1820
├── exceptions.py # PatterError + ErrorCode enum
1921
├── pricing.py # PricingUnit enum + provider price tables
2022
├── server.py # FastAPI app
2123
├── stream_handler.py # per-call orchestrator
22-
├── telephony/ # Twilio + Telnyx adapters (twilio.py / telnyx.py / common.py)
24+
├── telephony/ # Twilio + Telnyx + Plivo adapters (twilio.py / telnyx.py / plivo.py / common.py)
25+
├── carriers/ # carrier classes (twilio.py / telnyx.py / plivo.py)
2326
├── audio/ # transcoding, pcm_mixer, background_audio
2427
├── tools/ # tool_decorator, tool_executor
25-
├── providers/ # voice / LLM / STT / TTS providers
28+
├── providers/ # voice / LLM / STT / TTS provider adapters
2629
├── services/ # llm_loop, metrics, sentence_chunker, text_transforms, ivr, ...
2730
├── observability/ # event_bus + OTel tracing
31+
├── evals/ engines/ integrations/ # eval runner, engines, external integrations
2832
├── dashboard/
29-
├── tts/ stt/ # public namespaces (env-var auto-resolve)
33+
├── llm/ tts/ stt/ # public provider namespaces (env-var auto-resolve)
3034
└── ...
3135
```
3236

@@ -45,7 +49,7 @@ pip install -e ".[dev]" # editable install for development
4549
- pytest with `asyncio_mode = "auto"` — write `async def test_*`, no decorator needed.
4650
- Public dataclasses are `@dataclass(frozen=True)`. Tuples, not lists.
4751
- Async I/O everywhere. `httpx.AsyncClient`, `websockets.connect`. No `time.sleep`.
48-
- Logger: `logging.getLogger("patter")` — never `print()`.
52+
- Logger: `logging.getLogger("getpatter")` — never `print()`. Sub-namespaces like `getpatter.providers.deepgram_stt` are used per-module.
4953
- New config fields are optional with safe defaults (backward compat).
5054
- Authentic tests: mock only at paid/external boundary, tag `@pytest.mark.mocked`.
5155

libraries/typescript/CLAUDE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TypeScript SDK — agent quickstart
22

3-
This file is the per-library guide for AI agents working in `libraries/typescript/`. For repo-wide rules, see the root `CLAUDE.md` and `.claude/rules/`.
3+
This file is the per-library guide for AI agents working in `libraries/typescript/`. For repo-wide rules, see [`AGENTS.md`](../../AGENTS.md) and [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
44

55
## Layout
66

@@ -22,14 +22,15 @@ libraries/typescript/
2222
├── pricing.ts # PricingUnit + provider price tables
2323
├── server.ts # Express app
2424
├── stream-handler.ts # per-call lifecycle
25-
├── telephony/ # Twilio + Telnyx adapters (twilio.ts / telnyx.ts)
25+
├── telephony/ # Twilio + Telnyx + Plivo adapters (twilio.ts / telnyx.ts / plivo.ts)
26+
├── carrier-config.ts # carrier audio/format config
2627
├── audio/ # transcoding, background-audio
2728
├── tools/ # tool-decorator
28-
├── providers/ # voice / LLM / STT / TTS providers
29+
├── providers/ # voice / LLM / STT / TTS provider adapters
2930
├── services/ # call-log, ivr (mostly top-level files in src/)
3031
├── observability/
3132
├── dashboard/
32-
├── tts/ stt/ # public namespaces (env-var auto-resolve)
33+
├── llm/ tts/ stt/ # public provider namespaces (env-var auto-resolve)
3334
└── ...
3435
```
3536

0 commit comments

Comments
 (0)