Skip to content

docs: restructure B20 sidebar into Overview/Demos/Concepts/References - #1857

Open
rayyan224 wants to merge 66 commits into
masterfrom
rayyan-docs/b20-overhall
Open

docs: restructure B20 sidebar into Overview/Demos/Concepts/References#1857
rayyan224 wants to merge 66 commits into
masterfrom
rayyan-docs/b20-overhall

Conversation

@rayyan224

Copy link
Copy Markdown

What changed? Why?

Re-scaffolds the B20 nav group under Base Protocol → Core Primitives from a flat 6-item list into four buckets:

  • Overviewb20-token-standard.mdx (retitled in the sidebar via sidebarTitle)
  • Get Started / Demos — a new Playground page reviving the orphaned B20FlowDemo component, plus links to the existing get-started/issue-rwa and get-started/issue-stablecoins demo pages
  • Concepts — new precompiles.mdx stub, and index.mdx (now emptied to a stub pending a rewrite, relabeled "B20 Standard")
  • References — Interfaces, Constants & Addresses, Errors & Events

Also:

  • Removed the Invariants & Tests page (no inbound links besides the nav); added a redirect to Errors & Events.
  • Restored depth to the Beryl changelog's "Added" list (previously over-condensed to one sentence) as 4 component-level bullets: Policy Registry, Token Factory, B20 Asset, B20 Stablecoin.
  • Regenerated AGENTS.md via node scripts/agents.js since docs structure changed.

This is a sidebar-scaffolding pass — index.mdx and precompiles.mdx are intentionally left as stubs pending real content in a follow-up.

Notes to reviewers

  • No existing page paths were moved, so no redirects were needed except for the removed Invariants & Tests page.
  • Several other pages link to anchors on index.mdx (e.g. #roles-model, #factory, #asset) that currently point at a stub — this is intentional for now and will be resolved when that page's content is rewritten.

How has it been tested?

  • docs.json validated as parseable JSON.
  • New/changed MDX files checked for frontmatter, heading, and component syntax via /lint.
  • Not yet visually verified in mintlify dev — recommend a preview build to confirm the sidebar renders as expected and the Playground demo is interactive.

mindapivessa and others added 30 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>
- Update subtitle to "The blockchain for global finance."
- Remove the Explore section; add a Solutions card per use case
  (stablecoins, lending, tokenized stocks, payments, private txns)
- Rename "Facilitate Payments" -> "Accept Payments" (landing, nav
  group, and page title)
- Resources: drop Retroactive Funding and Join the Base Ecosystem,
  add Base dashboard link
- Set card titles to 1.25rem

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Redesign all 16 demo snippets around the generated Base design system,
rebuilding component anatomy (not just styling):

- Workflow demos (stablecoin, asset, DeFi, ledgers, payments, B20): horizontal
  stage navigation, split progress-rail / domain inspector workspace with a
  centralized action, and a separate transaction event log.
- Assistant demos: intentional landing composition with suggested prompts,
  detailed MCP tool-call cards (args + result tables), and a bottom composer.
- Transaction/signing approvals and the auth screen use the light Base
  modal/product system.
- Remove the decorative nav and header logo; put the stage row on the same
  line as the Demo tag and reset; drop the unused event-log auto-scroll toggle.

Add the official Base brand SVGs used by the demos.

Co-Authored-By: Claude <noreply@anthropic.com>
…emo, payer-info pay step

Co-Authored-By: Claude <noreply@anthropic.com>
Bring every interactive demo snippet in line with the Base design system
guidelines: dynamic dark mode, the BDS text-style variants, and correct
casing. Styling only — no logic, scripted-flow data, or interaction
behavior changed.

- Dark mode: convert each demo's hardcoded palette to CSS custom
  properties. Dark tokens resolve from both the system setting
  (prefers-color-scheme) and the docs' explicit theme toggle
  (html.dark / [data-theme="dark"]), with light overrides so the toggle
  wins in either direction. Demos now follow the docs theme dynamically
  instead of rendering light-only.
- Text styles: add in-snippet BDS text-variant classes
  (title2/title3/headline/body/caption/button/footnote/mono) with the
  correct sizes, weights, tracking, and md (768px) breakpoint; route
  visible text through them and drop conflicting inline font props.
- Casing: sentence-case UI chrome (e.g. "MCP tool call"; Blocked/Paused/
  Hidden/Public badges), leaving code identifiers, token symbols, and
  brands (B20, MCP, x402, Base Vibenet) untouched.

All 16 files parse as valid JSX; verified in light and dark across the
workflow, assistant, and auth demo families.

Co-Authored-By: Claude <noreply@anthropic.com>
…net guide

- Move launch-b20-token -> base-chain/network-information/b20-token-standard
  (Chain > Core Concepts), retitle "B20 Token Standard", reframe concepts-first;
  add redirect from the old path
- Replace the "Complete Launch a B20 token first" prerequisite note in 15
  issue-stablecoins/tokenize-stocks guides with a pointer to the standard page
- Re-point all internal links to the new path
- Add a "See technical details" CTA to the four use-case demos (Stablecoin,
  Asset, DeFi, Payments)
- Rewrite the Test on Vibenet page: intro, chain.base.org/vibenet iframe,
  network details, and faucet
- Regenerate llms.txt, llms-full.txt, and AGENTS.md

Co-Authored-By: Claude <noreply@anthropic.com>
- Drop the "Ethereum Layer 2" framing and remove em-dashes from the intro
- Rename the "Issue Stablecoins" quick-links group to "Issue Assets" and add
  stock-issuance links (tokenize stocks, create a stock token)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Adopt Mind's v2 IA branch as base and merge current master so no live
content regresses. Conflict resolutions:

- Kept V2's new IA: docs.json nav, base-chain/overview (Integrate Base
  landing), beryl/cobalt overviews, b20-token-standard (concept+launch),
  cobalt/eip-8130.
- Took master's reviewed operational fixes: node-operators/snapshots
  (reth V2 migration #1808, full-vs-minimal #1754).
- Brought in master's B20 reference tree (112 files, #1775/#1812/#1829)
  and both native-account-abstraction pages.
- Accepted deletions: apps/** (migrated to build-on-base; content
  preserved), base-account/guides/accept-recurring-payments,
  specs/upgrades/beryl/b20 (superseded; WS-B redirects it).
- Dropped committed build artifacts (.astro/, .mintlify/) and gitignored
  them.
- Generated indexes (AGENTS.md, llms.txt, llms-full.txt) left at V2;
  regenerated at end of pipeline.

Reconciliation of overlapping B20 specs, NAA dedupe, and adding master's
reference tree to nav is handled in follow-up workstreams.

Co-Authored-By: Claude <noreply@anthropic.com>
Spec (Specifications > B20): adopt master's canonical specs/reference/b20
tree (index + 6 interface pages in nav, ~102 method pages orphan-exempt,
constants, errors-and-events). Port V2's unique invariants + test cases
into a new specs/reference/b20/invariants-and-tests page, then delete
V2's superseded 879-line specs/b20/overview (its error reference is
already covered by master's errors-and-events). Add master's native
account abstraction reference to Specifications > Reference.

Changelog (Changelog tab > B20): consolidate to one B20 changelog under
specs/reference/b20/changelog — master's Beryl release notes plus the
Cobalt index and 3 entry pages (multiplier/ERC-8056, seize +
burnBlocked, composite policies), sourced verbatim from
base-std/changelog with selectors intact. Delete V2's specs/b20/changelog.

Repointed all 18 in-repo links off the deleted /specs/upgrades/beryl/b20
and /specs/b20/overview to the canonical /specs/reference/b20 (matching
master's redirect convention); Asset-only anchors (batch-mint,
multiplier, announcements) map to the nearest canonical section. Added
redirects for the 3 deleted URLs. No duplicate nav entries remain.

Deferred + flagged: moving the ~27 OP-stack per-fork spec pages
(exec-engine, derivation, proofs, span-batches, ...) out of the
Changelog tab into Specifications — they have no clean home in the
protocol-area-organized Specifications tree and V2's per-fork grouping
is coherent; a mass-move is high-risk/low-value. Left in place.

Co-Authored-By: Claude <noreply@anthropic.com>
Rename the section to "Issue RWA" per Legal's preferred term, with a
stock token kept as the worked example (one of many use cases):
- git mv build-on-base/tokenize-stocks -> build-on-base/issue-rwa and
  generalize the stock-specific filenames (create-an-asset-token,
  issue-units, cancel-blocked-units, announce-a-distribution,
  apply-a-multiplier; restrict-eligible-holders and pause-transfers
  unchanged); get-started/tokenize-stocks -> get-started/issue-rwa.
- Generalize titles/descriptions/keywords to RWA-first framing; drop
  "equity"/"onchain equity" and "security" as classifiers
  (create page description "security metadata" -> "issuer-defined
  metadata"; AssetDemo metadata key security-id -> asset-id).
- New reusable snippet snippets/RwaDisclaimer.mdx carrying both CB
  disclaimers verbatim + the "one of many use cases" framing (Legal
  scenario 1: approved with CB disclaimers); rendered on the landing
  and all 7 guides.
- Nav group "Tokenize Stocks" -> "Issue RWA"; visible "Tokenize stocks"
  labels in get-started/base, build-on-base/overview, sdks/overview
  updated; 8 redirects added for the renamed URLs.

Code blocks left byte-identical (verified-doc-samples); manifest
document paths updated to the new filenames. All 67 samples still sync;
new/changed pages lint clean.

Legal sign-off on the exact framing and the single term "RWA" remains an
open item (flagged in the plan); disclaimers ship verbatim pending that.

Co-Authored-By: Claude <noreply@anthropic.com>
Create base-chain/network-information/smart-contracts, a concept +
deploy page in Integrate Base > Reference: what a smart contract on Base
is, why Base needs its own Foundry build (native precompiles that stock
forge/cast/anvil can't simulate), and how to deploy to Base Sepolia with
base-forge/base-cast/base-anvil. Sourced from master's reviewed #1840
deploy-on-base page and the base/base-anvil README — no invented content,
no version pin (uses latest base-foundryup).

Delete the generic-Foundry get-started/deploy-smart-contracts orphan.
Redirects: /get-started/deploy-smart-contracts and the three
deploy-on-base URLs (previously pointed at make-a-transaction) now land
on the Smart Contracts page.

Co-Authored-By: Claude <noreply@anthropic.com>
Base Account (incl. Base Pay and the Wallet SDK) is rebranding to
Coinbase Wallet and leaving Base docs.

- Rename tab "SDKs & APIs" -> "CLIs & APIs"; delete docs/sdks/base-account
  (127 pages). New sdks/base-anvil CLI reference (from base/base-anvil)
  replaces the SDK tree; Base Chain API kept. Rewrote sdks/overview for
  the new tab.
- Holding page sdks/coinbase-wallet ("Base Account is now Coinbase
  Wallet"); repointed all 216 redirects that landed inside
  sdks/base-account to it, plus a /sdks/base-account/:slug* wildcard.
  TODO(verify): swap in the real Coinbase Wallet URL from TBA.
- Payments: dropped the Base Pay tab from from-humans and verify-a-payment
  (pages keep their USDC/B20 rails; verify unwrapped to a section);
  deleted collect-payer-info and accept-subscriptions (100% Base Pay) with
  redirects to from-humans; cleaned the accept-payments landing.
- Verified samples: removed the base-pay regions from from-humans.ts and
  verify.ts (and their now-unused @base-org/account imports), deleted the
  payer-info.ts and subscriptions.ts fixtures, and dropped the 6
  corresponding manifest entries. 61 samples still sync.
- Deleted 7 orphaned base-account demo snippets; cleaned Wallet-SDK /
  Base Account mentions in avoid-malicious-flags, resources-for-ai-agents,
  supported-chains, and PaymentsDemo (accept flow now wallet-agnostic;
  info/subscribe flows removed).

Structure validates (only the pre-existing index.mdx link false-positive
remains, fixed in WS-G); all touched pages lint clean.

Co-Authored-By: Claude <noreply@anthropic.com>
Resolve every nav orphan (24 -> 0, excluding footer pages and the
deliberately-unlisted B20 interface method pages):
- Restore to nav: get-started/base (the #1 page, as the Get Started
  landing), b20-token-standard and native-account-abstraction (into
  Integrate Base > Reference), block-explorers and data-indexers (into
  Integrate Base). Fixed two dead links on the restored landing
  (accept-subscriptions, base-mentorship-program).
- Delete + redirect 15 off-IA/stub pages (Coming-Soon stubs: apis,
  apply-for-funding, financing, run-a-base-node, sdks, concepts;
  superseded/off-strategy: launch-token -> b20-token-standard,
  learning-resources + prompt-library -> resources-for-ai-agents,
  get-funded -> base-ecosystem-fund, base-mentorship-program +
  country-leads-and-ambassadors -> base-batches, base-services-hub ->
  base-chain overview, b20-playground -> b20-token-standard, empty
  bug-bounty -> report-vulnerability). Repointed inbound redirects to
  final targets so no new chains are introduced.
- tone_of_voice.mdx added to .mintignore (internal style doc, not a page).
- Home/Get Started positioning marked WIP with a TODO(marcomms) note on
  the "incubated by Coinbase" line (Jesse Pollak's ask; owner: Xen's team).

No duplicate nav entries; structure validates (only the known index.mdx
link false-positive remains, fixed in WS-G).

Co-Authored-By: Claude <noreply@anthropic.com>
Extend scripts/validate-docs-structure.js:
- pageExists now resolves <page>/index.mdx, so links to a directory URL
  served by an index page (e.g. /base-chain/specs/reference/b20) validate
  correctly — clears the prior false-positives.
- Orphan detection: every publishable .mdx must be reachable from nav,
  exempting snippets, .mintignore'd files, footer legal pages, and the
  deliberately interface-first B20 method pages.
- Duplicate-nav detection.
- Refreshed the scoped link-check roots (issue-rwa, get-started/base).

New scripts/check-terminology.js: fails on retired-brand terms (Base Pay,
Base Account, @base-org/account, Coinbase Wallet SDK) outside the "moved
to Coinbase Wallet" pointers, on "equity"/"security" classifiers in Issue
RWA narrative, and on any RWA page missing <RwaDisclaimer />. Backed by
the Legal guidance doc and the Coinbase Wallet migration.

Both wired into scripts/verify-doc-samples.sh (the CI entrypoint); the
workflow now triggers on docs/** and the new script. All three checks
pass on the current tree.

Co-Authored-By: Claude <noreply@anthropic.com>
Regenerated docs/AGENTS.md, docs/llms.txt, and docs/llms-full.txt against
the final tree (47 dirs, 288 pages). Removed two stale hand-curated
sections from the llms-full.txt EXTRAS region whose sources were deleted
base-account pages. Indexes now carry zero references to removed pages
(base-account, tokenize-stocks, deploy-smart-contracts, specs/b20/overview)
and include the new surfaces (issue-rwa, base-anvil, Changelog). Generators
are idempotent on a second run.

Co-Authored-By: Claude <noreply@anthropic.com>
Rename the tab and its first group, the base-chain/overview landing
title, and every reference in docs-ia-guidelines.md and the docs-ia
skill. Regenerated AGENTS.md + llms indexes.

Co-Authored-By: Claude <noreply@anthropic.com>
Drop "Coinbase tokenized equities are only available to persons in
eligible jurisdictions outside of the U.S." from the shared
RwaDisclaimer snippet, removing it from every Issue RWA guide at once.
The general illustration/issuer-responsibility disclaimer and the
"one of many use cases" framing remain.

Co-Authored-By: Claude <noreply@anthropic.com>
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
youssefea and others added 28 commits August 24, 2026 19:26
Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Replace the Coming Soon stubs with short program overviews and apply links.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Capitalize Base Dashboard, update the Grants link, remove Builder Rewards,
add Base Ecosystem Fund under Funding, and move Base Batches under Growth
with the base.org/batches link.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Takes the three protocol/reference tabs from docs/ia-overhaul-v2 while keeping
this branch's Get Started and Build on Base work. The two v2 commits are
cherry-picked ahead of this one, so mind-apivessa's authorship is preserved for
the Base Protocol IA and the guidelines/B20 changelog work.

Tabs are now Get Started, Build on Base, Base Protocol, SDKs & APIs, Changelog.
The separate Specifications tab is gone — v2 folds spec content into Base
Protocol under Core Primitives, Network Systems, and Reference.

SDKs & APIs comes from v2, which restores the Base Account SDK tree (126 pages)
that WS-E had removed, along with v2's redirects for the /base-account,
/smart-wallet, and /onchainkit URL space. The sdks/coinbase-wallet "it moved"
stub is therefore obsolete and redirects to the Base Account overview.

Where v2 was simply behind master, this branch's content wins: the basectl
mention (#1779), the reth V2 snapshots callout (#1808), the security council
clarification (#1790), and the canonical /base-chain/specs/reference/b20 spec
links that v2 still pointed at pre-consolidation paths.

Pages v2's tabs had no slot for are re-homed rather than dropped:
smart-contracts, the native AA reference, block-explorers, and data-indexers to
Base Protocol > Reference; b20-token-standard to Core Primitives > B20 (20 pages
in the funnels link to it); specs/overview to Network Systems; base-anvil to a
CLIs group under SDKs & APIs. The full 88-line native AA page moves into v2's
nav slot at base-chain/specs/native-account-abstraction, replacing v2's "Coming
soon." stub, with a redirect from the old path.

Two v2 loose ends cleaned up: specs/b20/overview.mdx is deleted (v2 redirects
that URL to the B20 reference but left the file), and the redirect that shadowed
v2's own beryl/b20 changelog nav entry is dropped.

The terminology guard's retired-brand rule is rescoped from repo-wide to the
Get Started and Build on Base funnels, since the SDKs & APIs tab now documents
Base Account by design.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
Re-scaffolds the B20 nav group under Core Primitives into four buckets
(Overview, Get Started/Demos, Concepts, References), revives the
orphaned B20 playground demo component, drops the invariants-and-tests
page (redirected to errors-and-events), and restores depth to the
Beryl changelog's Added list.

Co-Authored-By: Claude <noreply@anthropic.com>
Collapse the B20 "Get Started / Demos" subgroup into a single Get
Started page. It lists every Tokenize Assets and Issue a Stablecoin
guide with a plain-language intent description, linking into the
Build on Base section. Remove the Playground page and redirect it to
Get Started.

Co-Authored-By: Claude <noreply@anthropic.com>
Separate the two user intents: Try B20 (outcome/demo-driven list of
guides) and Build with B20 (setup, repository, and implementation
scaffold). "Get Started" becomes a group with these two pages. Redirect
the old get-started and playground paths to Try B20.

Co-Authored-By: Claude <noreply@anthropic.com>
Base automatically changed from docs/use-case-ia-overhaul to master August 27, 2026 18:51
@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.

4 participants