Skip to content

WIP: Reorganize Base Chain docs IA#1417

Open
ericbrown99 wants to merge 3 commits into
masterfrom
mux/base-docs-codex-moly1dzt
Open

WIP: Reorganize Base Chain docs IA#1417
ericbrown99 wants to merge 3 commits into
masterfrom
mux/base-docs-codex-moly1dzt

Conversation

@ericbrown99

@ericbrown99 ericbrown99 commented May 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Reorganizes Base Chain docs around current builder/operator jobs and adds a new Chain overview.
  • Consolidates Flashblocks content into canonical Chain surfaces for block building, finality, RPC behavior, and node operation.

Absorbs PR #1600 (closes #1600):

  • Removes all wss://mainnet-preconf.base.org and wss://sepolia-preconf.base.org references from newFlashblocks.mdx, pendingLogs.mdx, and base-networks.mdx
  • Updates descriptions and JS examples to direct users to node providers for WebSocket support
  • Strips stale Flashblocks WSS and Standard WSS columns from the snippet

Content fixes:

  • Restores ecosystem-contracts.mdx (accidentally dropped by the IA reorg)
  • Distributes all Flashblocks FAQ content from the removed FAQ page into transaction-ordering.mdx, flashblocks-api-overview.mdx, and troubleshooting-transactions.mdx
  • Adds Wagmi, Viem, and Ethers library examples to flashblocks-api-overview.mdx
  • Updates stale "Azul activates" language to "Azul activated" throughout

RPC overview improvements:

  • Removes the duplicate "Endpoint URLs" accordion (content lives on connecting-to-base)
  • Standardizes all card groups to use no icons (removes inconsistency where only some cards rendered icons)
  • Tightens card descriptions to one sentence each

Specs:

  • Updates specs/overview.mdx lineage section to reference Azul as the Base Stack transition point
  • Removes stale Azul upgrade guide link from specs/protocol/overview.mdx

Rationale

This keeps the recent Chain docs work coherent as a single reviewable change: navigation, redirects, factual network references, API behavior, and AI-facing indexes all move together instead of landing in a partially inconsistent state.

Validation

  • Rebased onto latest origin/master.
  • Ran stale literal/link QA sweep for the Chain docs edits.
  • Ran node scripts/lint-mdx.js; it fails repo-wide on existing unrelated issues. The only PR-adjacent lint item is docs/snippets/base-networks.mdx missing frontmatter/no heading, matching existing imported-snippet patterns.

@ericbrown99 ericbrown99 added documentation Improvements or additions to documentation do not merge labels May 11, 2026
@cb-heimdall

cb-heimdall commented May 11, 2026

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

@mintlify

mintlify Bot commented May 11, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
base 🟢 Ready View Preview May 11, 2026, 10:19 PM

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

@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from cb86a3b to 71cee34 Compare May 11, 2026 22:31
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch 2 times, most recently from 16432e9 to c42e4a5 Compare May 12, 2026 13:59
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from c42e4a5 to 5f9b9e7 Compare May 12, 2026 14:18
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from 5f9b9e7 to 43b763a Compare May 12, 2026 14:20
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from 43b763a to faefefd Compare May 12, 2026 14:58
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from faefefd to ad5a830 Compare May 12, 2026 18:48
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from ad5a830 to 893d356 Compare May 13, 2026 14:27
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from 893d356 to 21c2d3e Compare May 13, 2026 15:20
@ericbrown99 ericbrown99 force-pushed the mux/base-docs-codex-moly1dzt branch from 21c2d3e to e335819 Compare May 21, 2026 21:57
ericbrown99 and others added 2 commits June 12, 2026 13:43
Consolidate Flashblocks content into canonical Chain surfaces, update Azul and network parameter references, and refresh redirects/indexes for the new IA.

Co-authored-by: Codex <noreply@openai.com>
@roethke roethke force-pushed the mux/base-docs-codex-moly1dzt branch from e335819 to 5c11197 Compare June 12, 2026 23:12
@roethke roethke marked this pull request as ready for review June 12, 2026 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants