Skip to content

docs: site-wide review updates#312

Merged
brendanjryan merged 5 commits into
mainfrom
docs/site-review-updates
Mar 14, 2026
Merged

docs: site-wide review updates#312
brendanjryan merged 5 commits into
mainfrom
docs/site-review-updates

Conversation

@brendanjryan

Copy link
Copy Markdown
Collaborator

Site-wide documentation review with the following changes:

  • GitHub dropdown: Remove backticks around SDK names — mppx (TypeScript), mpp-rs (Rust), pympp (Python)
  • IETF spec links: Update all tempoxyz.github.io/mpp-specs URLs → paymentauth.org (20 files)
  • Stripe overview: Replace ASCII diagram with Mermaid sequence diagram
  • FAQ updates:
    • Stablecoins → expanded to include Visa/Mastercard and Lightning
    • x402 compatibility → idempotency, receipts, request binding, fiat, sessions
    • "AI agent" → "Agent"
    • IETF standard → "submitted to the IETF standards track"
  • HTTP 402 page: Simplified intro
  • MCP transport: Renamed to "MCP and JSON-RPC transport" (page + sidebar)
  • Charge intents: Added Lightning card
  • Services page: First-party description → "Services which directly integrate with MPP"

Build passes (pnpm check:types + pnpm build).

@vercel

vercel Bot commented Mar 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mpp Ready Ready Preview, Comment Mar 14, 2026 4:34am

Request Review

Audit all 89 MDX pages against the style guide and fix ~200 violations:

- ts → ts twoslash for all standalone TypeScript code blocks (~130 instances)
- Add [bracketed tagline] to H1 headings on SDK reference pages (~39 pages)
- Alphabetize object properties in code examples (Challenge.from, Receipt.from, polyfill/methods order)
- Capitalize MPP protocol concepts (Challenge, Credential, Receipt)
- Replace e.g. with 'for example'
- Fix em dashes with spaces
- Remove filler words (seamlessly)
- Replace raw spec links with SpecCard components
- Fix conditional 'should' → active voice
- Add [terminal] labels to bash blocks
- Fix skipped heading levels
Return Type blocks, function signatures, and code using uninstalled
packages (lightning-mpp-sdk, elysia, express, hono) can't typecheck
as twoslash. Revert these 53 blocks back to bare ts while keeping
twoslash on Usage blocks that import from mppx/*.
Update AGENTS.md style guide and fix protocol/index.mdx and faq.mdx
to use 'IETF Specification' instead of 'IETF Specs' or 'IETF
Specifications'.
Add overscroll-behavior: none on html and overscroll-behavior: contain
on the sidebar container to prevent macOS rubber-band scrolling from
propagating when clicking sidebar sections.
- Remove backticks from GitHub dropdown SDK names
- Update all IETF spec links to paymentauth.org
- Replace ASCII diagram with Mermaid in Stripe overview
- Expand FAQ: stablecoins (add Visa/Lightning), x402 compat, Agent naming, IETF status
- Simplify HTTP 402 page intro
- Rename MCP transport to MCP and JSON-RPC
- Add Lightning card to charge intents page
- Update first-party services description on Services page
@brendanjryan brendanjryan force-pushed the docs/site-review-updates branch from c6533bf to bc353bf Compare March 14, 2026 04:32
@brendanjryan brendanjryan merged commit 88c4c4c into main Mar 14, 2026
8 checks passed
@brendanjryan brendanjryan deleted the docs/site-review-updates branch March 14, 2026 04:37
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.

1 participant