From 7bc209daa304672a64bdee9673290667b7fc03dd Mon Sep 17 00:00:00 2001 From: nhanhang47855 Date: Fri, 29 May 2026 20:30:05 +0700 Subject: [PATCH] update docs llms --- docs/get-started/docs-llms.mdx | 72 ++++++++++++++++++++++------------ 1 file changed, 47 insertions(+), 25 deletions(-) diff --git a/docs/get-started/docs-llms.mdx b/docs/get-started/docs-llms.mdx index 6676593b8..191c9d100 100644 --- a/docs/get-started/docs-llms.mdx +++ b/docs/get-started/docs-llms.mdx @@ -14,42 +14,64 @@ Use this file to discover all available pages before exploring further. If your AI tool doesn't support MCP yet, you can use a static documentation file instead. This gives your AI assistant the entire Base documentation as one text file. - - The static `llms-full.txt` file is a snapshot and may not include the latest updates. Use [MCP](/get-started/docs-mcp) when possible for always-current docs. - +The static `llms-full.txt` file is a snapshot and may not include the latest updates. Use [MCP](/get-started/docs-mcp) when possible for always-current docs. + +## Quickstart: Using Base Docs with LLMs + +### 1. Copy-paste into your AI tool + +**Example Prompt** (ready to use with Claude, Cursor, GPT, etc.): + +``` +You are an expert Base developer. Use the following full Base documentation as context: + + +{{paste the content of llms-full.txt here}} + + +Task: [Describe your task, e.g. "Write a complete Foundry project that deploys an ERC20 token on Base Sepolia, integrates Flashblocks for fast pre-confirmations, and includes verification + frontend connection with OnchainKit."] +``` + +### 2. Best Practices for Optimal Results + +- **Use section-specific files** for focused tasks (e.g. `./base-chain/llms-full.txt` or `./ai-agents/llms-full.txt`). + +- **Always cross-reference** in generated code: See `https://docs.base.org/...` + +- **Combine with the Prompt Library**: See [Developer's Guide to Effective AI Prompting](/get-started/prompt-library). + +- **Validate generated code** against current network details: [Base Chain Network Information](/base-chain/network-information). + +**Recommended cross-references**: + +- [Deploy Smart Contracts](/get-started/deploy-smart-contracts) + +- [Resources for AI Agents](/get-started/resources-for-ai-agents) + +- [Flashblocks Overview](/base-chain/flashblocks/overview) + +- [Base Chain RPC Reference](/base-chain/api-reference/rpc-overview) + +## Setup Guides ### Setup with Cursor [Cursor](https://cursor.com/) is an AI-powered code editor built as a fork of VS Code with features like AI code completion and natural language editing. - - - Go to **Settings** > **Features** > **Docs**. - +- Go to **Settings** > **Features** > **Docs**. - - Click **Add new doc** and paste: `https://docs.base.org/llms-full.txt` - +- Click **Add new doc** and paste: `https://docs.base.org/llms-full.txt`. - - Use `@docs -> Base` in your AI chat to reference the documentation. - - +- Use `@docs -> Base` in your AI chat to reference the documentation. ### Setup with Claude Code [Claude Code](https://docs.claude.com/en/docs/claude-code/overview) is an agentic coding tool that lives in your terminal and understands your codebase. - - - Download the static documentation file from: [https://docs.base.org/llms-full.txt](https://docs.base.org/llms-full.txt) - +- Download the static documentation file from: [https://docs.base.org/llms-full.txt](https://docs.base.org/llms-full.txt) + +- Save the file in your project directory or a known location on your system. - - Save the file in your project directory or a known location on your system. - +- Use the `/read` command or drag and drop the file path to include the documentation in your conversation. - - Use the `/read` command or drag and drop the file path to include the documentation in your conversation. Claude Code will then have access to the full Base documentation for that session. - - +- Claude Code will then have access to the full Base documentation for that session.