-
Notifications
You must be signed in to change notification settings - Fork 414
Update ai-assisted-documentation-reading.mdx #882
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
🟡 Heimdall Review Status
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request removes all documentation content from the AI-Assisted Documentation Reading guide and adds a last_updated frontmatter field. The change appears problematic as it leaves the file with only metadata and no actual content.
Changes:
- Removed 75 lines of documentation content including techniques for understanding documentation, prompts, and examples
- Added
last_updated: January 2026field to the frontmatter - Left the file with only frontmatter (title, description) and no body content
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| title: AI-Assisted Documentation Reading | ||
| description: Develop strategies for using AI tools to understand complex technical documentation and troubleshoot development challenges | ||
| --- | ||
|
|
||
| # Techniques for understanding documentation | ||
|
|
||
| AI tools excel at breaking down complex technical content into understandable explanations and practical guidance tailored to your specific learning needs and project requirements. Below are three techniques that you can use to leverage AI to help you understand documentation. | ||
|
|
||
| ### Used tailored prompts | ||
|
|
||
| The "Explain Like I'm a Vibe Coder" approach involves asking AI to simplify technical concepts while maintaining practical applicability. This technique is particularly effective for understanding blockchain concepts, API documentation, and complex development patterns. The key is providing context about your current knowledge level and specific goals rather than asking for generic explanations. | ||
|
|
||
| <Accordion title="Explain Like I'm a Vibe Coder Prompt"> | ||
| ``` | ||
| I'm looking at this API documentation but finding it confusing. | ||
| I want to implement the `Checkout` component on the checkout.tsx page of my website. | ||
| Please explain this like I'm a Vibe Coder (someone new to blockchain development but familiar with basic web development): | ||
| ``` | ||
|
|
||
| ```typescript Checkout.tsx | ||
| const chargeHandler = async () => { | ||
| const response = await fetch('/createCharge', { method: 'POST' }); | ||
| const { id } = await response.json(); | ||
| return id; // Return charge ID | ||
| }; | ||
|
|
||
| <Checkout chargeHandler={chargeHandler}> | ||
| <CheckoutButton /> | ||
| </Checkout>; | ||
| ``` | ||
|
|
||
| </Accordion> | ||
|
|
||
| ### Use Screenshots | ||
|
|
||
| Sharing a screenshot with AI enhances its ability to understand your problem significantly. When you encounter confusing documentation sections, interfaces, or error messages, including screenshots in your AI prompts provides visual context that pure text cannot convey. Most AI tools can analyze images and provide specific guidance based on what they observe in your screenshots. | ||
|
|
||
| <Accordion title="Screenshot Prompt"> | ||
| ``` | ||
| I'm looking at this API documentation but finding it confusing. I want to implement the `Checkout` component on the checkout.tsx page of my website. | ||
| I have attached two screenshots. The first screenshot is the page I would like to implement the `Checkout` component on. The second screenshot is the API documentation I am looking at. | ||
| Please explain this like I'm a Vibe Coder (someone new to blockchain development but familiar with basic web development): | ||
| [Screenshot 1] | ||
| [Screenshot 2] | ||
| ``` | ||
|
|
||
| </Accordion> | ||
|
|
||
| ### Use code snippets | ||
|
|
||
| Code snippet analysis is another powerful technique. When you find example code in documentation but don't understand how it applies to your situation, you can paste the code into an AI prompt along with your specific requirements. The AI can explain the code's purpose, modify it for your needs, and highlight potential issues or improvements. | ||
|
|
||
| <Accordion title="Code Snippet Prompt"> | ||
| ``` | ||
| I'm looking at this API documentation but finding it confusing. Please explain this like I'm a Vibe Coder (someone new to blockchain development but familiar with basic web development): | ||
| [PASTE DOCUMENTATION SECTION HERE] | ||
| Specifically help me understand: | ||
| 1. What this API does in simple terms | ||
| 2. When I would use it in my Mini App | ||
| 3. What the key parameters mean | ||
| 4. A practical example with my specific use case: [DESCRIBE YOUR USE CASE] | ||
| Break it down step-by-step and include a working code example I can copy and modify. | ||
| ``` | ||
|
|
||
| </Accordion> | ||
| ``` | ||
| last_updated: January 2026 |
Copilot
AI
Jan 23, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change removes all documentation content (75 lines) from the file, leaving only the frontmatter. The file now has no body content at all. This appears to be unintentional, as:
- The PR description is empty and provides no explanation for removing all content
- The title suggests a minor update, not a complete content removal
- The remaining frontmatter references "strategies for using AI tools to understand complex technical documentation" but there's no actual content explaining these strategies
If this content removal is intentional, please update the PR description to explain why. Otherwise, this appears to be an accidental deletion that should be reverted.
|
|
||
| </Accordion> | ||
| ``` | ||
| last_updated: January 2026 |
Copilot
AI
Jan 23, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The last_updated frontmatter field is not used elsewhere in the documentation. A search across the docs directory shows this is the only file with this field. This creates inconsistency in the documentation structure. If you want to track when documentation was last updated, consider:
- Using a field that matches the documentation framework's conventions (check the framework documentation)
- Applying this field consistently across all documentation files
- Removing this field if it's not supported by your documentation system
Additionally, no other files in the docs/cookbook directory use this frontmatter field, suggesting it may not be recognized or used by the documentation framework.
What changed? Why?
Notes to reviewers
How has it been tested?