Skip to content

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

Open
rayyan224 wants to merge 3 commits into
docs/use-case-ia-overhaulfrom
rayyan-docs/b20-overhall
Open

docs: restructure B20 sidebar into Overview/Demos/Concepts/References#1857
rayyan224 wants to merge 3 commits into
docs/use-case-ia-overhaulfrom
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.

rayyan224 and others added 3 commits August 26, 2026 16:27
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>
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