docs: trim root README to integrator-facing content - #13
Merged
Conversation
bufo24
force-pushed
the
docs/fix-root-readme
branch
from
July 7, 2026 08:15
f9a53af to
267c799
Compare
bufo24
changed the title
The root README is read by developers integrating the SDK, not by maintainers of it. Removed the maintainer-only Development and Releasing sections (build/test, refresh-schema, codegen, release-please flow) — all of which are already documented in CLAUDE.md. Also fixed the quick-start snippet: it referenced an undefined `env` variable, and used `apiKey` for API calls when payments resources require `serviceApiKey` (the scoped x-api-key).
bufo24
force-pushed
the
docs/fix-root-readme
branch
from
July 7, 2026 08:21
267c799 to
81c84d2
Compare
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.
What
The root
README.mdis read by developers integrating the SDK, not by maintainers of it. Two changes:Development(install/typecheck/test/build,refresh-schema,codegen) andReleasingsections are contributor concerns and don't belong in a consumer-facing README. All of it is already documented inCLAUDE.md, so nothing is lost.payments.wallets.list({ environmentId: env.id })referenced an undefinedenv; it now fetches an environment first, matchingpackages/payments/README.md.What remains is integrator-focused: packages overview, install, quick start, link to full payments docs, license.
Scope
Root README only. The
core,payments, andexamplesREADMEs were reviewed and are accurate — left untouched.