Skip to content

fix(docs): resolve broken links and legacy mdBook routes in specs and agents #1831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vhtgzzl wants to merge 1 commit into
base: master
Choose a base branch
from
+24 −24
Open

fix(docs): resolve broken links and legacy mdBook routes in specs and agents #1831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/agents/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords: ["Base MCP", "AI agent wallet", "mcp.base.org", "AI assistant wallet",

import { WalletSetupDemo } from "/snippets/WalletSetupDemo.jsx"

Base MCP gives your AI assistant direct access to your [Base Account](/base-account) (the smart wallet powering the Base App). Connect once and your assistant can check balances, send funds, swap tokens, sign messages, execute contract calls, and pay x402-enabled APIs across multiple networks. Every write action requires your approval.
Base MCP gives your AI assistant direct access to your [Base Account](/base-account/overview/what-is-base-account) (the smart wallet powering the Base App). Connect once and your assistant can check balances, send funds, swap tokens, sign messages, execute contract calls, and pay x402-enabled APIs across multiple networks. Every write action requires your approval.

<Visibility for="agents">
If you're looking for the canonical machine-readable docs index, fetch the uppercase `AGENTS.md` at https://docs.base.org/AGENTS.md — note the uppercase filename (`AGENTS.md`, not `agents.md`). It's a compact, directory-grouped index of the entire Base documentation, built for agents to navigate before generating code.
Expand Down
46 changes: 23 additions & 23 deletions docs/base-chain/specs/protocol/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,17 @@ The following diagram shows how the major protocol components interact across L1
```mermaid
graph LR
subgraph "Ethereum L1"
OptimismPortal(<a href="./bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
BatchInbox(<a href="../reference/glossary.html#batcher-transaction">Batch Inbox Address</a>)
DisputeGameFactory(<a href="./proofs/contracts.html#disputegamefactory">DisputeGameFactory</a>)
OptimismPortal(<a href="/base-chain/specs/protocol/bridging/withdrawals#the-optimism-portal-contract">OptimismPortal</a>)
BatchInbox(<a href="/base-chain/specs/reference/glossary#batcher-transaction">Batch Inbox Address</a>)
DisputeGameFactory(<a href="/base-chain/specs/protocol/proofs/contracts#disputegamefactory">DisputeGameFactory</a>)
end

subgraph "L2 Node"
RollupNode(<a href="./consensus/">Consensus</a>)
ExecutionEngine(<a href="./execution/">Execution Engine</a>)
RollupNode(<a href="/base-chain/specs/protocol/consensus">Consensus</a>)
ExecutionEngine(<a href="/base-chain/specs/protocol/execution">Execution Engine</a>)
end

Batcher(<a href="./batcher.html">Batcher</a>)
Batcher(<a href="/base-chain/specs/protocol/batcher">Batcher</a>)
Proposers(Proposers)
Challengers(Challengers)
Users(Users)
Expand Down Expand Up @@ -137,7 +137,7 @@ from the Batch Inbox and deposit events from OptimismPortal, constructs payload
execution engine via the Engine API. Unsafe (unconfirmed) blocks are gossiped to other nodes over a dedicated
P2P network to give validators low-latency access before batches land on L1.

[Consensus →](./consensus/)
[Consensus →](/base-chain/specs/protocol/consensus)

```mermaid
graph LR
Expand Down Expand Up @@ -169,7 +169,7 @@ processes blocks produced by consensus. Predeploys (system contracts at fixed L2
and preinstalls extend the EVM for rollup-specific functionality such as fee distribution, L1 block attribute
injection, and cross-domain messaging.

[Execution →](./execution/)
[Execution →](/base-chain/specs/protocol/execution)

### Bridging

Expand All @@ -178,7 +178,7 @@ start of each L2 block. Withdrawals flow in the opposite direction: a withdrawal
a proposer submits an output root to `DisputeGameFactory`, and after the challenge period the user proves and
finalizes the withdrawal on L1 via `OptimismPortal`.

[Bridging →](./bridging/deposits)
[Bridging →](/base-chain/specs/protocol/bridging/deposits)

```mermaid
graph LR
Expand Down Expand Up @@ -215,14 +215,14 @@ The batcher is a service run by the sequencer that compresses L2 transaction dat
them as calldata (or blobs) to the Batch Inbox Address on L1. This is the data availability layer that allows
any validator to independently reconstruct the L2 chain from L1.

[Batcher →](./batcher)
[Batcher →](/base-chain/specs/protocol/batcher)

```mermaid
graph LR
Sequencer(Sequencer)
Batcher(<a href="./batcher.html">Batcher</a>)
BatchInbox(<a href="../reference/glossary.html#batcher-transaction">Batch Inbox Address</a>)
RollupNode(<a href="./consensus/">Rollup Node</a>)
Batcher(<a href="/base-chain/specs/protocol/batcher">Batcher</a>)
BatchInbox(<a href="/base-chain/specs/reference/glossary#batcher-transaction">Batch Inbox Address</a>)
RollupNode(<a href="/base-chain/specs/protocol/consensus">Rollup Node</a>)

Sequencer -->|L2 blocks| Batcher
Batcher -->|compressed channel frames| BatchInbox
Expand All @@ -243,15 +243,15 @@ through `DisputeGameFactory`, proof material is checked by the onchain verifier
challengers can dispute invalid claims. Valid withdrawals can only be finalized through
`OptimismPortal` once the associated game resolves in favor of the proposer.

[Proofs →](./proofs/)
[Proofs →](/base-chain/specs/protocol/proofs)

```mermaid
graph LR
Proposer(Proposer)
DGF(<a href="./proofs/contracts.html#disputegamefactory">DisputeGameFactory</a>)
Game(<a href="./proofs/contracts.html#aggregateverifier">AggregateVerifier game</a>)
DGF(<a href="/base-chain/specs/protocol/proofs/contracts#disputegamefactory">DisputeGameFactory</a>)
Game(<a href="/base-chain/specs/protocol/proofs/contracts#aggregateverifier">AggregateVerifier game</a>)
Challengers(Challengers)
OP(<a href="./bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
OP(<a href="/base-chain/specs/protocol/bridging/withdrawals#the-optimism-portal-contract">OptimismPortal</a>)

Proposer -->|submit checkpoint proof| DGF
DGF -->|create game| Game
Expand All @@ -275,8 +275,8 @@ The following diagram demonstrates this interaction and key Base protocol compon
```mermaid
graph TD
subgraph "Ethereum L1"
OptimismPortal(<a href="./bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
BatchInbox(<a href="../reference/glossary.html#batcher-transaction">Batch Inbox Address</a>)
OptimismPortal(<a href="/base-chain/specs/protocol/bridging/withdrawals#the-optimism-portal-contract">OptimismPortal</a>)
BatchInbox(<a href="/base-chain/specs/reference/glossary#batcher-transaction">Batch Inbox Address</a>)
end

Sequencer(Sequencer)
Expand Down Expand Up @@ -313,10 +313,10 @@ proof game contract that proposes the state of the L2 at a given point in time.
```mermaid
graph LR
subgraph "Ethereum L1"
BatchInbox(<a href="../reference/glossary.html#batcher-transaction">Batch Inbox Address</a>)
DisputeGameFactory(<a href="./proofs/contracts.html#disputegamefactory">DisputeGameFactory</a>)
ProofGame(<a href="./proofs/contracts.html#aggregateverifier">AggregateVerifier game</a>)
OptimismPortal(<a href="./bridging/withdrawals.html#the-optimism-portal-contract">OptimismPortal</a>)
BatchInbox(<a href="/base-chain/specs/reference/glossary#batcher-transaction">Batch Inbox Address</a>)
DisputeGameFactory(<a href="/base-chain/specs/protocol/proofs/contracts#disputegamefactory">DisputeGameFactory</a>)
ProofGame(<a href="/base-chain/specs/protocol/proofs/contracts#aggregateverifier">AggregateVerifier game</a>)
OptimismPortal(<a href="/base-chain/specs/protocol/bridging/withdrawals#the-optimism-portal-contract">OptimismPortal</a>)
ExternalContracts(External Contracts)
end

Expand Down