|
1 | | -# Documentation Repository |
| 1 | +# Base Documentation |
2 | 2 |
|
3 | | -## Stack |
4 | | -- Mintlify for documentation site |
5 | | -- MDX files in `docs/` folder |
6 | | -- Storybook for component demos |
| 3 | +Technical documentation for Base (Ethereum L2). Built with Mintlify. |
7 | 4 |
|
8 | | -## Git |
9 | | -- Primary branch: `master` |
| 5 | +## Commands |
10 | 6 |
|
11 | | -## Key References |
12 | | -- `mintlify-reference.md` — Mintlify component syntax and usage |
13 | | -- `content-instructions.md` — Content guidelines |
14 | | -- `global-tone-voice.mdx` — Tone and voice standards |
15 | | -- `docs.json` — Site navigation and configuration |
| 7 | +| Command | Description | |
| 8 | +|---------|-------------| |
| 9 | +| `mintlify dev` | Local dev server | |
| 10 | +| `/lint` | Lint MDX files and fix issues | |
| 11 | +| `/doc-feedback` | Review content quality | |
16 | 12 |
|
17 | | -## Conventions |
18 | | -- Use American English spelling |
19 | | -- Sentence case for headings |
20 | | -- All images wrapped in `<Frame>` |
21 | | -- Code blocks must specify a language |
22 | | -- Use Mintlify callouts sparingly (`<Note>`, `<Tip>`, `<Warning>`, `<Info>`, `<Check>`) |
| 13 | +## Structure |
23 | 14 |
|
24 | | -## Commands |
25 | | -- `/lint` — Check MDX formatting and Mintlify component usage |
| 15 | +``` |
| 16 | +docs/ |
| 17 | +├── get-started/ # Intro, quickstarts |
| 18 | +├── base-chain/ # Network, nodes, tools |
| 19 | +├── base-account/ # Smart Wallet SDK |
| 20 | +├── base-app/ # Agent development |
| 21 | +├── mini-apps/ # MiniKit guides |
| 22 | +├── onchainkit/ # React components (versioned) |
| 23 | +├── cookbook/ # Tutorials |
| 24 | +├── learn/ # Solidity, Ethereum basics |
| 25 | +├── images/ # Assets by topic |
| 26 | +├── snippets/ # Reusable MDX components |
| 27 | +└── docs.json # Navigation config |
| 28 | +``` |
| 29 | + |
| 30 | +## Content Rules |
| 31 | + |
| 32 | +**Frontmatter** (required): |
| 33 | +```yaml |
| 34 | +--- |
| 35 | +title: "Keyword-rich title" |
| 36 | +description: "Value description" |
| 37 | +--- |
| 38 | +``` |
| 39 | + |
| 40 | +**Writing**: American English, sentence case headings, second person ("you"), active voice. |
| 41 | + |
| 42 | +**Code blocks**: Always specify language. Add filename or title. Use `highlight={}` for emphasis. |
| 43 | + |
| 44 | +**Components**: See [mintlify-reference.md](mintlify-reference.md) for syntax. |
| 45 | + |
| 46 | +**Images**: Wrap in `<Frame>`, include `alt` attribute. |
| 47 | + |
| 48 | +## Navigation |
| 49 | + |
| 50 | +Edit `docs.json` to add/remove pages. Add redirects when removing pages. |
| 51 | + |
| 52 | +## References |
| 53 | + |
| 54 | +| File | Purpose | |
| 55 | +|------|---------| |
| 56 | +| [content-instructions.md](content-instructions.md) | Writing guidelines | |
| 57 | +| [mintlify-reference.md](mintlify-reference.md) | Component syntax | |
| 58 | +| [scripts/README.md](scripts/README.md) | Linter usage | |
26 | 59 |
|
27 | 60 | ## Before Committing |
28 | | -- Run `/lint` and fix any errors |
29 | | -- If removing docs, add redirects in `docs.json` |
30 | | -- Ensure all internal links are valid |
| 61 | + |
| 62 | +1. Run `/lint` and fix errors |
| 63 | +2. Add redirects for removed pages |
| 64 | +3. Verify links work |
0 commit comments