docs: consolidate agent playbook and LLM reference pages#112
Conversation
- Rewrite llm-api-reference as human-facing 'Building with AI Agents' guide with llms.txt discovery, compact schema table, and modern framework-agnostic integration patterns (replaces outdated LangChain/OpenAI Assistants examples) - Add Discovery section with llms.txt link to agent-playbook - Keep agent-playbook concise for machine consumption - Reorder sidebar: Errors > Postman > API reference > Building with AI Agents > Agent Playbook
|
@blink-claw-bot review |
There was a problem hiding this comment.
Pull request overview
This PR consolidates overlapping LLM/agent documentation by separating content into an agent-facing playbook and a developer-facing “Building with AI Agents” guide, and updates navigation ordering accordingly.
Changes:
- Rewrites
llm-api-referenceinto a developer guide with llms.txt discovery, schema downloads, and updated integration patterns. - Adds a Discovery section + cross-linking in the AI Agent API Playbook.
- Reorders the API docs sidebar entries to match the new intended reading flow.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| sidebars.js | Reorders sidebar items so the developer guide precedes the agent playbook. |
| docs/api/llm-api-reference.md | Reframes page as a human-facing integration guide; adds discovery, downloads table, and new Python/Node patterns. |
| docs/api/agent-playbook.md | Adds llms.txt discovery pointer and links back to the developer guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
blink-claw-bot
left a comment
There was a problem hiding this comment.
Excellent consolidation work! ✅
This PR effectively addresses the overlapping content issue and creates a cleaner information architecture. Here's my detailed review:
✅ Clarity & Structure
- Much improved title: "Building with AI Agents" clearly targets developers vs. the previous LLM-centric approach
- Logical flow: Discovery → Schema downloads → Integration patterns → Resources
- Clear audience separation: Explicit tip directing agents to the playbook instead
✅ Content Quality
- Practical integration patterns: System prompt, Python, Node.js examples cover the most common use cases
- Discovery section addition: The
llms.txtreference creates a proper entry point for agents - Technical accuracy: Verified links are accessible (llms.txt, schema files) and content matches current API structure
✅ Information Architecture
- Eliminates duplication: No longer two competing pages with overlapping agent guidance
- Better sidebar ordering: Moving specialized topics (LLM reference, agent playbook) to the bottom makes sense
- Cross-references updated: Agent playbook now properly links to the consolidated guide
✅ Developer Experience
- Framework-agnostic approach: Shows the pattern works with any LLM provider
- Copy-paste ready examples: Practical code snippets developers can immediately use
- Reduced confusion: Single source of truth for AI integration guidance
Minor Observations
- The content reduction (101 lines removed, 81 added) demonstrates effective consolidation
- Maintains consistent tone throughout both modified files
- All referenced resources are properly accessible
Great work consolidating these overlapping resources into a more coherent developer experience! 🚀
🤖 Review by claude-sonnet-4 via Blink-Claw-Bot
Summary
The "API Reference for LLMs" and "AI Agent API Playbook" pages had overlapping content. This PR gives each a clear audience:
llms.txtand a link to the human guide in Related Reading.llms.txtdiscovery sectionSidebar reorder
Errors > Postman > API reference (external) > Building with AI Agents > AI Agent API Playbook
The playbook sits last as the capstone agent-facing page.
Files changed
docs/api/agent-playbook.md— added Discovery section + cross-linkdocs/api/llm-api-reference.md— full rewrite as human-facing guidesidebars.js— reordered entries