Skip to content

Restructure top-level navigation (mockup)#1420

Draft
SahilAujla wants to merge 9 commits into
mainfrom
nav-restructure-mockup
Draft

Restructure top-level navigation (mockup)#1420
SahilAujla wants to merge 9 commits into
mainfrom
nav-restructure-mockup

Conversation

@SahilAujla

@SahilAujla SahilAujla commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

What

Mockup of the proposed top-level navigation restructure, for review of the final experience/structure. Draft — not intended to merge as-is.

New tab order: Chains · Data · Wallets · Build with AI · Tools & Resources · Changelog

  • Node merged into Chains — the Node API is our implementation of the standard JSON-RPC API, but the actual APIs live in Chains. The Chains tab now opens with an Introduction (Chain APIs Overview, Node API Overview, Supported Chains, MEV Protection, Pricing), then the cross-chain WebSockets / Yellowstone gRPC / Trace API / Debug API sections, then the per-chain sections (unchanged).
  • Rollups removed from top level — temporary home at the bottom of Chains as "Launch Your Own Chain (Rollups)", framed for customers who want to launch their own L2, until deprecation is conveyed to all customers.
  • Build with AI promoted to its own top-level tab for visibility.
  • Get Started renamed to "Tools & Resources" (tab key resources, keeps the tutorials slug so URLs are unchanged). The "Get Started" page is slated to become the docs homepage/landing page in a follow-up (needs a frontend change, not docs.yml).

URL safety

  • All 616 page references and every API spec are preserved (verified old vs. new docs.yml).
  • MDX pages pin URLs via frontmatter slugs, so moving them between tabs changes nothing — /docs/node and /docs/rollups keep working.
  • Only nav-generated endpoint URLs under /docs/node/... move; wildcard redirects cover them, and existing redirect destinations into those trees are repointed to avoid double hops.

Open questions (from the nav feedback doc)

  • Final name for the former Get Started tab ("Tools & Resources" used here).
  • Whether Rollups docs should be removed entirely instead of rehomed (pending answer from the Rollups team).

🤖 Generated with Claude Code

@SahilAujla @claude
Restructure top-level navigation (mockup)
5fc42fc 
Reorganizes the docs tabs to match how users look for information:

- Merge the Node tab into Chains: the Node API is our implementation of
  the standard JSON-RPC API, but the actual APIs live under Chains. The
  Chains tab now opens with an Introduction (Chain APIs Overview, Node
  API Overview, Supported Chains, MEV Protection, Pricing) followed by
  the cross-chain WebSockets, Yellowstone gRPC, Trace API, and Debug API
  sections and then the per-chain sections.
- Remove the deprecated Rollups tab from top level; its pages get a
  temporary home at the bottom of Chains as "Launch Your Own Chain
  (Rollups)" until deprecation is communicated to all customers.
- Promote Build with AI to its own top-level tab for visibility.
- Rename Get Started to "Tools & Resources" (tab key: resources). The
  tab keeps the "tutorials" slug so existing URLs are unchanged; the
  Get Started page is slated to become the docs homepage in a follow-up.

All 616 pages and every API spec reference are preserved. MDX pages pin
their URLs via frontmatter slugs, so only nav-generated endpoint URLs
under /docs/node/... move; wildcard redirects cover those, and existing
redirect destinations into the moved trees are repointed to avoid
double hops.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 2, 2026 •
edited
Loading

Copy link
Copy Markdown

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Jul 2, 2026, 10:31 PM

SahilAujla and others added 6 commits July 2, 2026 16:01
@SahilAujla @claude
Adapt nav restructure to docs-site rendering rules
1482153 
- Nest the cross-chain sections (WebSockets, Yellowstone gRPC, Trace API,
  Debug API, Rollups) inside the chains tab's Introduction section: the
  docs site's chain selector treats every top-level section after the
  first as a chain. skip-slug keeps endpoint URLs at /chains/<section>/.
- Rename the resources tab key back to get-started (display name stays
  "Tools & Resources") so the frontend header's active-tab matching and
  the /docs/get-started landing link keep working.
- Pin the Build with AI overview at /docs/build-with-ai as the landing
  page for the new top-level tab, with a redirect from the old
  /docs/build-with-ai-overview URL.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Merge Chain APIs Overview and Node API Overview into one API Overview…
71204ec 
… page

Both sections now live in the same Chains tab, so the two overview pages
are combined into a single API Overview at /docs/chains. The old
/docs/node URL redirects there, and the Tools & Resources landing page
now points its card and prose at the merged page. Also fixes the Trace
API card link, which pointed at the Transfers API quickstart.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Move Yellowstone gRPC under the Solana chain section
89d098e 
It is Solana-only, so it belongs with Solana rather than in the
cross-chain Introduction group. All its pages keep their pinned
/docs/reference/yellowstone-grpc-* URLs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Move Alchemy Quickstart Guides to the top of Tutorials in Tools & Res…
edce5e1 
…ources

All pages keep their pinned /docs/* URLs; nav-only move.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Hide the Get Started page and drop the Introduction section from Tool…
d84e2b4 
…s & Resources

/docs/get-started stays routable for old links and redirects but is out
of the sidebar and search. The tab's landing page is now Pricing Plans
(header change in docs-site).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Rename Pricing & Resources to Pricing; hoist the redundant inner Pric…
aae639c 
…ing group

All pages keep pinned /docs/reference/* URLs; section slug unchanged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla

SahilAujla commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator Author

Full-experience preview (new header + this branch's content) — share this link for review:

https://docs-git-nav-restructure-mockup-alchemy-dot-com.vercel.app/docs/api/preview/start?branch=nav-restructure-mockup&sig=2365b725f0a6ad43bed3d839b5a0dfb879436a901f5377d25b0750741817aeb4&redirect=/docs/reference/pricing-plans

(The auto-generated preview link above shows this branch's content under the production header, so the new top-level tabs won't appear there. The link in this comment uses the paired docs-site deployment from OMGWINNING/docs-site#344.)

SahilAujla and others added 2 commits July 2, 2026 18:28
@SahilAujla @claude
Fix code that keyed on the removed node tab and chains-tab nav position
b315fe5 
Audit findings from the nav restructure:
- addEvmChainHelpers generated method links into the removed /docs/node/
  tree for newly added chains; now /docs/chains/ (matches actual endpoint
  URLs, which lived under the chains tab already)
- Algolia chain-title disambiguation treated the chains tab's first
  ancestor section as a chain name, which would title methods under the
  new cross-chain Introduction grouping as 'method - Introduction'.
  Breadcrumbs now carry a skipSlug marker and skip-slug groupings yield
  no chain suffix. Regression test added.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla @claude
Document the Daikon temporal-workflow coupling on the chains tab
7aa08cd 
The bot hard-requires the chains tab key, inserts new chains before the
next '- tab:' line (silent no-op if chains is last), and scans only
top-level sections for per-chain api entries. Audit finding; comment
only.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SahilAujla

SahilAujla commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator Author

Audit: logic keyed on tab names, nav position, or filenames (per Daniel's request)

Swept docs-site, the content-indexer/scripts/CI in this repo, and the Temporal workflows (found in OMGWINNING/dashboard → temporal-worker/src/workflows/daikon-docs/). Change surface audited: removed node/rollups tabs, new build-with-ai tab, get-started display rename, nav renesting (Introduction grouping, Yellowstone→Solana), one deleted file (node-api-overview.mdx).

Broken → fixed (commits on the mockup branches)

  1. docs-site llms.ts derived tab keys from the header link path in 3 places (labels, nav-tree fetch, cache tags). Broke once Tools & Resources started linking to /reference/pricing-plans: its tree dropped out of llms.txt and its revalidation tag went stale. Now keys on the explicit tab id (e4f0e5c).
  2. src/utils/addEvmChainHelpers.ts generated new-chain method tables linking into /docs/node/<chain>/... — dead tree (actually stale since chains left the Node tab pre-branch). Now /docs/chains/... (b315fe50).
  3. Algolia chain-title disambiguation (getChainNameFromAncestors) treated the chains tab's first ancestor section as a chain name → methods under the new cross-chain "Introduction" grouping would've been titled trace_block - Introduction. Breadcrumbs now carry a skipSlug marker; skip-slug groupings yield no chain suffix. Regression test added (b315fe50).

Load-bearing constraints (hold on this branch; documented in docs.yml)

  • Daikon specs Temporal workflow hard-requires a tab keyed exactly chains (nonretryable failure otherwise) and inserts new chain sections before the next - tab: line — a silent no-op if chains ever becomes the last tab. It scans only top-level sections for per-chain api-name entries. Verified: regex matches branch docs.yml; only trace/debug moved deeper, which the bot never scanned (they lived in the node tab). Guard comment added at the chains tab (7aa08cd3).
  • docs-site chain selector: first chains section = overview, rest = chains — nav was shaped to comply from the start.

Verified unaffected

Daikon servers workflow (fixed spec paths), weekly changelog automation (GitHub Action, writes only content/changelog/*.md, no tab assumptions), content-indexer core (fully docs.yml-driven; index-main-content.yml derives tab keys dynamically via yq), redirects plumbing, sitemap/llms routes (data-driven), search UI, both repos' test suites (green, incl. 233 indexer tests).

Stale-but-harmless (not changed)

Marketing copy in both repos still says "Node APIs … and Rollups" (metadata.ts in each — worth a copy pass when this ships); two indexer test fixtures exercise a node tab scenario (self-contained, still pass).

🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@SahilAujla