Skip to content

docs: use-case IA overhaul — Payments, SDKs & APIs, Ledgers; cut off-strategy sections - #1772

Open
youssefea wants to merge 5 commits into
masterfrom
docs/use-case-ia-overhaul
Open

docs: use-case IA overhaul — Payments, SDKs & APIs, Ledgers; cut off-strategy sections#1772
youssefea wants to merge 5 commits into
masterfrom
docs/use-case-ia-overhaul

Conversation

@youssefea

Copy link
Copy Markdown
Contributor

What changed? Why?

Restructures the docs from product-based to use-case-based navigation for technical decision-makers, and executes the sections on top of it. (Supersedes #1770, which was auto-closed when its poorly-named branch mux/docs-claude-2 was renamed to docs/use-case-ia-overhaul — same work, correctly named branch.)

IA & Get Started

  • Four tabs: Get Started / Build on Base (use cases) / Chain / SDKs & APIs [WIP]
  • Rewrote the two highest-traffic dissatisfied pages: get-started/base and ecosystem-bridges
  • "Coding agents" group: resources-for-ai-agents, docs-mcp, docs-llms

Build on Base (use-case sections)

  • Facilitate Payments — landing + 5 byte guides + PaymentsDemo
  • Private Transactions (Ledgers) — small single-intent byte guides (deposit / transfer / withdraw) + LedgersDemo with a privacy readout; overview folded into the landing
  • Issue Stablecoins retained as the exemplar pattern

SDKs & APIs

  • Relocated base-accountsdks/base-account (preserves link equity); curated into Base Account SDK + Base Chain API; new hub + SDK landing

The cut

  • Removed /agents (Base MCP), /apps (MiniKit), /onchainkit, plus the empty Perps and Integrate DeFi stubs
  • 301-redirected every removed/moved URL; repointed destinations out of cut trees; regenerated AGENTS.md / llms.txt / llms-full.txt

Polish

  • Title Case across sidebar page titles + group names (code identifiers and acronyms preserved)
  • Site-wide draft banner flagging that this is for IA review, not page content

Notes to reviewers

  • This is a draft for information-architecture review — evaluate structure/navigation, not per-page content (content is still being written; the banner says so).
  • Two lint bug fixes in scripts/lint-mdx.js (closing fences + HTML comments inside code fences were false-flagged). Remaining lint errors are all pre-existing (snippet component false-positives, spec/legal multiple-H1).

How has it been tested?

  • mintlify dev renders new/changed pages; all demos load and flow scoping works
  • node scripts/lint-mdx.js all: 0 errors in new/migrated content
  • Full nav resolves across all tabs; 0 redirect destinations land in cut trees; 0 redirect chains; every removed URL has a redirect; no live page links into a cut tree

mindapivessa and others added 5 commits July 29, 2026 14:19
Turn the Issue Stablecoins stub into a Stripe-style, demo-driven section
built around the B20 stablecoin variant.

- Get Started landing (get-started/issue-stablecoins) with an interactive
  demo above a CardGroup of the issuer jobs
- Eight short, single-purpose Build on Base pages: issue, mint, burn,
  restrict, block, recover, pause, reconcile
- New self-contained StablecoinDemo.jsx snippet (flow selector, timeline,
  progress bar, animated log, balances) replacing the Visibility-wrapped
  reuse that failed to render
- Nav: Issue Stablecoins ordered above Integrate DeFi in both tabs;
  redirect for the removed stub; page title capitalized

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
…tegy sections

Execute the use-case IA overhaul (Phases 1–4) on top of the skeleton.

Facilitate Payments (Phase 1)
- New Solutions landing get-started/agentic-payments + 5 byte guides under
  build-on-base/agentic-payments (accept, verify, payer info, subscriptions, x402)
- New scripted snippets/PaymentsDemo.jsx (5 flows), modeled on StablecoinDemo
- Rewrite get-started/base (use-case-first) and ecosystem-bridges (route chooser)

SDKs & APIs (Phase 2)
- Relocate base-account -> sdks/base-account (whole tree; preserves link equity)
- Curated tab: Overview / Base Account SDK / Base Chain API
- New sdks/overview (hub) + sdks/base-account/overview (SDK landing)

The cut (Phase 3)
- Delete /agents (Base MCP), /apps (MiniKit), /onchainkit
- 301-redirect every removed/moved URL (615 -> 791); repoint 362 destinations
  out of cut trees; fix 133 pre-existing danglers; repoint surviving cross-links
- Delete stale per-section llms shards; regenerate AGENTS.md + llms.txt/llms-full.txt

Scaffolding (Phase 4)
- Fill Start Here trio, use-base-with-ai (x402), build-on-base/overview,
  get-started/{base-chain,sdks-and-apis} landings

Tooling: fix two real lint-mdx.js bugs (closing fences and HTML comments inside
fenced code blocks were false-flagged). No lint errors in new/migrated content.

Co-Authored-By: Claude <noreply@anthropic.com>
…t DeFi/Perps

Nav & IA refinements on top of the use-case overhaul:

- Get Started "Agents" group renamed to "Coding agents" = resources-for-ai-agents,
  docs-mcp, docs-llms. Removed "Build on Base with AI" (use-base-with-ai); repointed
  its 69 inbound redirects to resources-for-ai-agents.
- Reshaped Ledgers to the byte-guide pattern: removed ledgers-overview and folded its
  value-prop into the get-started/private-transactions landing; added small single-intent
  guides build-on-base/ledgers/{deposit,transfer,withdraw} with scoped demos; new
  snippets/LedgersDemo.jsx (deposit/transact/withdraw flows with a privacy readout).
- Removed the Perps section and the Integrate DeFi section (Get Started + Build on Base).
  Perps redirects to overview; DeFi removed without redirects (empty stubs).
- Title Case across all sidebar page titles and group names, preserving code identifiers
  (method names) and acronyms/brands.
- Added a site-wide draft banner and marked the "SDKs & APIs [WIP]" tab.
- Regenerated AGENTS.md, llms.txt, llms-full.txt.

Co-Authored-By: Claude <noreply@anthropic.com>
Remove the orange `type`/`color` override; keep the default banner style.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
base 🟢 Ready View Preview Aug 4, 2026, 9:54 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

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.

3 participants