Skip to content

Commit d50a5fc

Browse files
authored
Final QA items (#10)
* Update docs.json with onchain app dev structure * Fix mdx styling syntax * Fix storybook sizing * Replace Callout components with proper components
1 parent e6669fe commit d50a5fc

File tree

210 files changed

+5693
-1192
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+5693
-1192
lines changed

.cursor/rules/general.mdc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
globs:
4+
alwaysApply: true
5+
---
6+
Don't edit or use the /_pages directory. The files we're editing are in the /docs directory

docs/CLAUDE.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Repository Overview
6+
7+
This is the **Base Documentation** repository, a comprehensive documentation site for Base (Ethereum Layer 2 blockchain) built with **Mintlify**. The repository covers blockchain development from basics to advanced topics including smart contracts, onchain apps, and Base ecosystem tools.
8+
9+
## Key Commands
10+
11+
### Local Development
12+
```bash
13+
# Install Mintlify CLI globally (required for local development)
14+
npm i -g mintlify
15+
16+
# Run local development server
17+
mintlify dev
18+
19+
# Reinstall dependencies if mintlify dev fails
20+
mintlify install
21+
```
22+
23+
### Storybook Development
24+
```bash
25+
cd storybook
26+
npm install
27+
npm run storybook # Runs on port 6006
28+
npm run build-storybook
29+
```
30+
31+
## Architecture and Structure
32+
33+
### Documentation Organization
34+
- **Tab-based navigation** with 7 main sections in `docs.json`:
35+
- Get Started (introduction, quickstarts)
36+
- Base Chain (network info, node operations)
37+
- Smart Wallet (account abstraction)
38+
- OnchainKit (React components)
39+
- Wallet App (MiniKit development)
40+
- Cookbook (use-case guides)
41+
- Learn (educational content)
42+
43+
### File Structure
44+
- **Main content**: All documentation files are in `/docs` directory as `.mdx` files
45+
- **Configuration**: `docs.json` defines navigation structure and site settings
46+
- **Images**: Organized in `/images` with subdirectories by topic
47+
- **Custom components**: React components available in `/snippets`
48+
- **Styling**: `custom.css` for site-wide styles, `iframe-theme.js` for theme handling
49+
50+
### Content Types
51+
- **Educational tutorials** (Learn section with Solidity, Ethereum basics)
52+
- **Practical guides** (Cookbook with real-world implementation examples)
53+
- **API documentation** (OnchainKit components and utilities)
54+
- **Tool documentation** (Smart Wallet, development frameworks)
55+
56+
## Development Workflow
57+
- Use sub-agents to help complete tasks
58+
- Leverage the Github CLI tool to create commits for changes and to read the history of changes
59+
- If you create scratch files for problem solving, remove them when you are done with them.
60+
61+
### Content Editing
62+
- Edit `.mdx` files directly in `/docs` directory (NOT `/_pages`)
63+
- Use Mintlify syntax for enhanced documentation features
64+
- Changes are automatically deployed via Mintlify GitHub App when pushed to default branch
65+
66+
### Component Development
67+
- Storybook setup in `/storybook` directory for UI component development
68+
- Components integrated into documentation via iframe embedding
69+
- Chromatic integration for visual testing and regression detection
70+
71+
### Important Rules
72+
- **Never edit files in `/_pages` directory** - all documentation files are in `/docs`
73+
- Use Mintlify CLI for local development and testing
74+
- Follow existing navigation structure defined in `docs.json`
75+
- Images should be placed in appropriate `/images` subdirectories
76+
77+
## Special Features
78+
79+
### AI Integration
80+
- Contextual AI options (ChatGPT, Claude) available in documentation interface
81+
- Large `llms-full.txt` file (11,496 lines) provides comprehensive AI context
82+
- AI prompting guides integrated throughout documentation
83+
84+
### Interactive Components
85+
- Storybook components embedded via iframes for interactive examples
86+
- Dark/light mode support with custom theme handling
87+
- Custom React components available for enhanced documentation experiences
88+
89+
### Cross-referencing
90+
- Extensive internal linking between related topics
91+
- Progressive learning paths from beginner to advanced
92+
- Use-case driven organization alongside technical reference material
93+
94+
## Deployment
95+
96+
- **Automatic deployment** via Mintlify GitHub App when changes are pushed to default branch
97+
- **Storybook deployment** to Chromatic for component library hosting
98+
- No manual deployment steps required for documentation updates

docs/base-chain/network-information/ecosystem-contracts.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,9 @@ This page lists contract addresses for onchain apps that we have deployed.
6666

6767
#### Testnet interfaces
6868

69-
:::info
70-
69+
<Info>
7170
Two community projects, [BaseX](https://basex-test.vercel.app/swap?currencyA=ETH&currencyB=0x036CbD53842c5426634e7929541eC2318f3dCF7e&focus=source) and [DapDap](https://testnet.base.dapdap.net/uniswap/swap), provide testnet interfaces for Uniswap contracts if you prefer to interact in the browser instead of with the contracts directly.
72-
73-
:::
71+
</Info>
7472

7573
### Uniswap v2
7674

docs/base-chain/node-operators/run-a-base-node.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You'll need your own L1 RPC URL. This can be one that you run yourself, or via a
5656
3. Uncomment the line relevant to your network (`.env.sepolia`, or `.env.mainnet`) under the 2 `env_file` keys in `docker-compose.yml`.
5757
4. Run `docker compose up`. Confirm you get a response from:
5858

59-
```bash [Terminal]
59+
```bash Terminal
6060
curl -d '{"id":0,"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false]}' \
6161
-H "Content-Type: application/json" http://localhost:8545
6262
```
@@ -90,7 +90,7 @@ You'll then need to untar the downloaded snapshot and place the `geth` subfolder
9090

9191
Return to the root of your Base node folder and start your node.
9292

93-
```bash [Terminal]
93+
```bash Terminal
9494
cd ..
9595
docker compose up --build
9696
```
@@ -103,7 +103,7 @@ Check the latest block to make sure you're syncing from the snapshot and that it
103103

104104
You can monitor the progress of your sync with:
105105

106-
```bash [Terminal]
106+
```bash Terminal
107107
echo Latest synced block behind by: $((($(date +%s)-$( \
108108
curl -d '{"id":0,"jsonrpc":"2.0","method":"optimism_syncStatus"}' \
109109
-H "Content-Type: application/json" http://localhost:7545 | \

docs/base-chain/tools/onchain-registry-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This endpoint will display all Onchain Registry entries subject to any query par
3131

3232
#### Response
3333

34-
```json [JSON]
34+
```json JSON
3535
{
3636
"data": [
3737
{
@@ -98,7 +98,7 @@ This endpoint will display a single Onchain Registry entry that is being activel
9898

9999
#### Response
100100

101-
```json [JSON]
101+
```json JSON
102102
{
103103
"data": {
104104
"id": "7AsRdN8uf601fCkH1e084F",

docs/base-chain/tools/tokens-in-wallet.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ Coinbase Wallet makes any ERC-20 token instantly available for swapping seconds
99

1010
Follow the instructions below to ensure your token logo, asset name, and other metadata also appear on Coinbase Wallet.
1111

12-
:::info[Disclaimer]
12+
<Info>
13+
**Disclaimer**
14+
1315
Base does not endorse any specific token that is deployed on mainnet and made available for swapping.
14-
:::
16+
</Info>
1517

1618
---
1719

@@ -41,9 +43,11 @@ However, you’ll still need to list your token on Birdeye, CoinGecko, or CoinMa
4143

4244
Tokens that are newly launched and haven’t had significant trading volume appear in the **newer token** section. Once your token reaches a market cap of at least $1M it will no longer be displayed in this section.
4345

44-
:::info[Disclaimer]
46+
<Info>
47+
**Disclaimer**
48+
4549
New assets with low liquidity may result in failed swaps or may result in a user receiving less of the destination token due to slippage. An important responsibility of the token creator is to communicate to the community these risks.
46-
:::
50+
</Info>
4751

4852
## How can I update my token logo or description?
4953

docs/cookbook/defi-your-app.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ You can get a vault address from Morpho's [Vaults page](https://app.morpho.org/b
116116
</Info>
117117

118118

119-
```tsx twoslash
119+
```tsx
120120
// @noErrors: 2307
121121
import { Earn } from '@coinbase/onchainkit/earn'; // [!code focus]
122122
@@ -261,7 +261,7 @@ This component requires a `projectId` to be set in the `OnchainKitProvider`. You
261261
</Note>
262262

263263

264-
```tsx twoslash
264+
```tsx
265265
import { Buy } from '@coinbase/onchainkit/buy'; // [!code focus]
266266
import type { Token } from '@coinbase/onchainkit/token';
267267

0 commit comments

Comments
 (0)