docs: improve LLM optimization guide with usage examples and cross-links#1548
Open
tien9486 wants to merge 1 commit into
Open
docs: improve LLM optimization guide with usage examples and cross-links#1548tien9486 wants to merge 1 commit into
tien9486 wants to merge 1 commit into
Conversation
Collaborator
🟡 Heimdall Review Status
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed? Why?
The LLM-optimized files (
llms.txt,llms-full.txt,docs-llms.mdx) are great for discoverability but can be improved for better LLM consumption and developer experience. Add a clear "How to Use These Files" section, more explicit prompt examples, cross-references toprompt-library.mdxand relevant sections (e.g., Base Chain API, Agents), and a simple validation snippet.Aligns with AI-agents push on Base; makes docs more actionable for builders using LLMs/Cursor/Claude to generate Base code. Small, high-impact, no structure changes.
Notes to reviewers
Focused PR touching
docs/get-started/docs-llms.mdx, regenerate/updatellms*.txtvia scripts if applicable, minor links in related files.Add cross-links in
prompt-library.mdxand agents.md pointing back to LLM docs.Ensure code blocks specify language (e.g.,
bash,solidity).Update any outdated references if found during review (e.g., network details post recent upgrades like v0.8/v0.9).