Add V2 SDK getting started pages, remove V1 nav sections#18
Closed
vraspar wants to merge 1 commit into
Closed
Conversation
Rewrites overview and installation pages for V2 API (createX402r, role presets, action groups). Adds create-client and typescript pages. Removes Merchant, Client, Arbiter, Facilitator, and Experimental nav groups from SDK tab — files stay on disk for later cleanup. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
vraspar
force-pushed
the
vraspar/docs-getting-started
branch
from
b9e1d03 to
7186ab3
Compare
Contributor
Author
|
Closing in favor of a rewrite with improved writing quality. See DOCS_WRITING_GUIDE.md for the new approach. |
6 tasks
A1igator
pushed a commit
that referenced
this pull request
Mar 31, 2026
## Summary Replaces PR #18 with a full rewrite of the 4 Getting Started pages following the new [DOCS_WRITING_GUIDE](https://github.com/BackTrackCo/x402r-notes/blob/main/plans/DOCS_WRITING_GUIDE.md) anti-slop rules. **What changed:** - `sdk/overview.mdx` — landing page feel, leads with x402 vs x402r contrast, real chain tables - `sdk/installation.mdx` — shortest page on the site, jumps straight to install command - `sdk/create-client.mdx` — decision tree between `createX402r()` and role presets, config reference - `sdk/typescript.mdx` — reference sheet with role narrowing tables verified against `types.ts` - `docs.json` — adds `create-client` and `typescript` to Getting Started nav, removes `concepts` and `limitations` **Writing approach:** - Every opening answers "why would I read this?" not "what is this page about?" - Code first, prose annotates only non-obvious behavior - Real addresses from `config/index.ts`, not placeholders - Structural variety: each page has a different feel (landing page / quick-start / decision tree / reference sheet) - All signatures verified against `x402r-sdk/packages/sdk/src/types.ts` ## Test plan - [x] `npx mintlify broken-links` passes - [x] Anti-slop grep (no banned words: powerful, seamless, robust, allows you to, etc.) - [x] All function signatures match `types.ts` - [x] Role narrowing tables match Pick types (lines 235-379) - [x] `getChainConfig` confirmed re-exported from `@x402r/sdk` - [ ] Preview deploy renders correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 (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
sdk/overview.mdxandsdk/installation.mdxfor V2 API (createX402r, role presets, action groups)sdk/create-client.mdx(config reference, role presets, extend, payment store)sdk/typescript.mdx(type imports, role narrowing tables, error types)Test plan
npx mintlify broken-linkspassesnpx mint devrenders all 4 pages correctlynew X402rClient,@x402r/client,getNetworkConfig) in new pages🤖 Generated with Claude Code