Skip to content

Commit b8df095

Browse files
soheimamclaude
andcommitted
Merge origin/master into feat/agent-file
Resolve claude.md conflict by keeping the detailed version. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 parents 96ba487 + 4bd083d commit b8df095

28 files changed

Lines changed: 2097 additions & 353 deletions

File tree

.claude/skills/doc-feedback.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: reviewing-documentation
3+
description: Reviews documentation for quality, consistency, and style guide adherence. Use when reviewing changed docs or before publishing new content.
4+
---
5+
6+
# Documentation Feedback
7+
8+
## Workflow
9+
10+
1. **Get files to review**
11+
```bash
12+
git diff --name-only HEAD -- '*.mdx'
13+
git diff --name-only master...HEAD -- '*.mdx'
14+
```
15+
If `$ARGUMENTS` provided, review that path instead.
16+
17+
2. **Run linter first**
18+
```bash
19+
node scripts/lint-mdx.js $ARGUMENTS
20+
```
21+
22+
3. **Review against style guide** — See [content-instructions.md](../../content-instructions.md)
23+
24+
4. **Provide feedback** per file:
25+
- What's working well
26+
- Specific suggestions with line references
27+
- Linter issues (if any)
28+
29+
5. **Offer to fix** issues if requested
30+
31+
## Review checklist
32+
33+
```
34+
Review Progress:
35+
- [ ] Terminology consistent
36+
- [ ] Code examples complete and runnable
37+
- [ ] No placeholder values (foo, bar, example.com)
38+
- [ ] Headings descriptive and keyword-rich
39+
- [ ] Content scannable (headings, lists, white space)
40+
- [ ] Active voice, second person
41+
- [ ] Troubleshooting included where appropriate
42+
```

.claude/skills/lint.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: linting-mdx
3+
description: Runs deterministic MDX linter and helps fix formatting, structure, and Mintlify component issues. Use when checking documentation quality or before committing changes.
4+
---
5+
6+
# Lint MDX
7+
8+
Run the linter:
9+
10+
```bash
11+
node scripts/lint-mdx.js $ARGUMENTS
12+
```
13+
14+
Arguments: (none) = changed files, `all` = everything, or specify a path.
15+
16+
## Workflow
17+
18+
1. Run linter, present results
19+
2. If errors found, offer to fix them
20+
3. Prioritize errors over warnings
21+
22+
## References
23+
24+
- [mintlify-reference.md](../../mintlify-reference.md) — component syntax
25+
- [content-instructions.md](../../content-instructions.md) — writing guidelines

claude.md

Lines changed: 57 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,64 @@
1-
# Documentation Repository
1+
# Base Documentation
22

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.
74

8-
## Git
9-
- Primary branch: `master`
5+
## Commands
106

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 |
1612

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
2314

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 |
2659

2760
## 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

docs/CLAUDE.md

Lines changed: 0 additions & 98 deletions
This file was deleted.

0 commit comments

Comments
 (0)