Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Commit 26c9207

Browse files
committed
changed title for clarity
1 parent c30ab61 commit 26c9207

2 files changed

Lines changed: 25 additions & 27 deletions

File tree

apps/base-docs/docs/pages/builderkits/onchainkit/guides/ai-guide.mdx renamed to apps/base-docs/docs/pages/builderkits/onchainkit/guides/ai-prompting-guide.mdx

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Developer's Guide to Effective AI Prompting'
2+
title: 'AI Prompting Guide'
33
description: Learn practical AI prompting techniques to enhance your coding workflow and get better results from AI coding assistants.
44
author: sohey
55
---
@@ -25,10 +25,10 @@ This is why providing relevant context upfront is crucial \- the AI can only wor
2525

2626
To get the most out of AI assistants:
2727

28-
1. **Prioritize relevant information**: Focus on sharing the most important details first
29-
2. **Remove unnecessary content**: Avoid pasting irrelevant code or documentation
30-
3. **Structure your requests**: Use clear sections and formatting to make information easy to process
31-
4. **Reference external resources**: For large codebases, consider sharing only the most relevant files
28+
1. **Prioritize relevant information**: Focus on sharing the most important details first.
29+
2. **Remove unnecessary content**: Avoid pasting irrelevant code or documentation.
30+
3. **Structure your requests**: Use clear sections and formatting to make information easy to process.
31+
4. **Reference external resources**: For large codebases, consider sharing only the most relevant files.
3232

3333
For larger projects, create and reference a central documentation file that summarizes key information, rather than repeatedly explaining the same context.
3434

@@ -72,12 +72,12 @@ A comprehensive instructions file helps AI tools understand your project better.
7272
```
7373
Create a detailed instructions.md file for my project with the following sections:
7474
75-
1. Overview: Summarize the project goals, problem statements, and core functionality
76-
2. Tech Stack: List all technologies, libraries, frameworks with versions
77-
3. Project Structure: Document the file organization with explanations
78-
4. Coding Standards: Document style conventions, linting rules, and patterns
79-
5. User Stories: Key functionality from the user perspective
80-
6. APIs and Integrations: External services and how they connect
75+
1. Overview: Summarize the project goals, problem statements, and core functionality.
76+
2. Tech Stack: List all technologies, libraries, frameworks with versions.
77+
3. Project Structure: Document the file organization with explanations.
78+
4. Coding Standards: Document style conventions, linting rules, and patterns.
79+
5. User Stories: Key functionality from the user perspective.
80+
6. APIs and Integrations: External services and how they connect.
8181
```
8282

8383
:::info
@@ -111,8 +111,6 @@ Here's the relevant code:
111111
[paste your code]
112112
```
113113

114-
###
115-
116114
### **Ask for Iterations**
117115

118116
Start simple and refine through iterations rather than trying to get everything perfect in one go.
@@ -121,10 +119,10 @@ Start simple and refine through iterations rather than trying to get everything
121119

122120
```
123121
Let's approach this step by step:
124-
1. First, implement a basic version of [feature] with minimal functionality
125-
2. Then, we'll review and identify areas for improvement
126-
3. Next, let's add error handling and edge cases
127-
4. Finally, we'll optimize for performance
122+
1. First, implement a basic version of [feature] with minimal functionality.
123+
2. Then, we'll review and identify areas for improvement.
124+
3. Next, let's add error handling and edge cases.
125+
4. Finally, we'll optimize for performance.
128126
129127
Please start with step 1 now.
130128
```
@@ -148,10 +146,10 @@ I'm implementing a swap component with OnchainKit. Here's the relevant LLMs.txt:
148146
@https://docs.base.org/builderkits/onchainkit/llms.txt
149147
150148
Based on this documentation, please show me how to implement a wallet connector that:
151-
1. Swap from base usdc to base th
152-
2. Handles connection states properly
153-
3. Includes error handling
154-
4. Follows best practices for user experience
149+
1. Swap from Base USDC to Base ETH.
150+
2. Handles connection states properly.
151+
3. Includes error handling.
152+
4. Follows best practices for user experience.
155153
```
156154

157155
### **Component Integration Example**
@@ -162,10 +160,10 @@ Based on this documentation, please show me how to implement a wallet connector
162160
I need to implement a new feature in my project.
163161
164162
1. Shows the connected wallet's balance of our {ERC20 token}.
165-
2. It Updates when the balance changes.
166-
3. Handles loading and error states appropriately
167-
4. Follows our project's coding standards
168-
5. Update our instructions.md to reflect this new implementation
163+
2. It updates when the balance changes.
164+
3. Handles loading and error states appropriately.
165+
4. Follows our project's coding standards.
166+
5. Update the instructions.md to reflect this new implementation.
169167
170168
```
171169

apps/base-docs/sidebar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ export const sidebar: Sidebar = [
7878
link: '/builderkits/onchainkit/guides/using-ai-powered-ides',
7979
},
8080
{
81-
text: 'AI Guide',
82-
link: '/builderkits/onchainkit/guides/ai-guide',
81+
text: 'AI Prompting Guide',
82+
link: '/builderkits/onchainkit/guides/ai-prompting-guide',
8383
},
8484
],
8585
},

0 commit comments

Comments
 (0)