Skip to content

claude.md

Latest commit

 

History

History
66 lines (49 loc) · 2.24 KB

claude.md

File metadata and controls

66 lines (49 loc) · 2.24 KB

Base Documentation

Technical documentation for Base (Ethereum L2). Built with Mintlify.

Commands

Command Description
mintlify dev Local dev server
/lint Lint MDX files and fix issues
/doc-feedback Review content quality
/agents Generate AGENTS.md index for AI agents (also runs via githooks/post-commit when commit message contains agents.md)
/llms Regenerate docs/llms.txt and docs/llms-full.txt (also runs via githooks/post-commit when commit message contains llms.txt)

Structure

docs/
├── get-started/      # Intro, quickstarts
├── base-chain/       # Network, nodes, tools
├── base-account/     # Smart Wallet SDK
├── ai-agents/        # Agent development
├── apps/             # Apps on Base (MiniKit, guides)
├── onchainkit/       # React components (versioned)
├── images/           # Assets by topic
├── snippets/         # Reusable MDX components
└── docs.json         # Navigation config

Content Rules

Frontmatter (required):

---
title: "Keyword-rich title"
description: "Value description"
---

Writing: American English, sentence case headings, second person ("you"), active voice.

Code blocks: Always specify language. Add filename or title. Use highlight={} for emphasis.

Components: See mintlify-reference.md for syntax.

Images: Wrap in <Frame>, include alt attribute.

Navigation

Edit docs.json to add/remove pages. Add redirects when removing pages.

References

File Purpose
content-instructions.md Writing guidelines
mintlify-reference.md Component syntax
scripts/README.md Linter usage

Before Committing

  1. Run /lint and fix errors
  2. Run /agents if docs structure changed
    • Or include agents.md / llms.txt in your commit message — the githooks/post-commit hook will regenerate the matching index files and create a follow-up commit. Enable hooks once per clone with git config --local core.hooksPath githooks (repo-scoped, never global).
  3. Add redirects for removed pages
  4. Verify links work