Skip to content

Preview use-case-first docs navigation#1713

Open
youssefea wants to merge 1 commit into
masterfrom
docs-ia-usecase-preview
Open

Preview use-case-first docs navigation#1713
youssefea wants to merge 1 commit into
masterfrom
docs-ia-usecase-preview

Conversation

@youssefea

@youssefea youssefea commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Summary

This is a navigation-only preview of a use-case-first Base docs IA for team review. It updates docs/docs.json so the visible top-level tabs are:

  • Get Started
  • Trading
  • Payments
  • Protocol
  • SDKs
  • APIs

No .mdx files are moved, renamed, edited, or deleted, and no redirects are added.

Screenshot 2026-07-13 at 18 54 02

IA notes

  • Dissolves the previous Apps tab into use-case buckets.
  • Removes Agents as a top-level tab while keeping the files on disk and direct URLs intact.
  • Surfaces agents/guides/x402-payments under Payments because x402 is a payments use case.
  • Cross-lists Ledgers pages under both Trading and Payments.
  • Cross-lists the shared Build group under both Trading and Payments:
    • Sign in with Base
    • Basenames
    • Wallet UX
    • Sponsor gas (Paymaster)
    • Builder Codes
  • Splits reference into SDKs for importable client libraries and APIs for HTTP/RPC endpoints.

Verification

  • npx mintlify dev --port 3004
    • Preview started successfully.
    • No missing navigation page warnings after the final nav update.
  • npx mintlify broken-links
    • Command exited 0.
    • It still reports 43 existing broken links under AGENTS.md and agents/skills/*; none are from the new navigation paths.
  • Custom JSON/path checks:
    • Only navigation.tabs changed outside formatting.
    • All nav page references resolve to existing .mdx files.
    • Agents tab is absent.
    • agents/guides/x402-payments appears under Payments.
    • Shared Build groups in Trading and Payments are identical.
    • Ledgers pages appear in both Trading and Payments.

Open items before production

  • Swaps has no standalone guide in the visible nav. The current swap guide lives under the now-hidden Agents section at agents/guides/swap-tokens; decide whether to author a general swaps guide or surface that page under Trading.
  • Builder Codes and Paymaster/sponsor gas are cross-listed in both Trading and Payments per reviewer feedback; confirm this reads well or choose a primary home before production.
  • get-started/deploy-smart-contracts and apps/quickstart/deploy-on-base are related but distinct, so both are kept under Get Started -> Build an app.
  • Base MCP / Agents may leave this repo entirely; the hidden-but-present treatment is interim.
  • The brief calls for get-started/build-app as the canonical Build an app quickstart, but this checkout does not contain docs/get-started/build-app.mdx. To keep Mintlify preview clean without moving files in this preview PR, the nav uses the existing apps/quickstart/build-app page. The production pass should add/move the canonical page and redirects as part of the URL cleanup.

Follow-up

File moves, canonical URLs, and redirects are intentionally left for a later production pass.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Codex <codex-noreply@coinbase.com>
@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.

2 participants