[codex] mention llms indexes in agent docs#69
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThese changes update documentation to introduce two LLM-oriented index files ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What changed
This PR adds explicit documentation that the Fish Audio docs site already exposes built-in LLM-friendly indexes:
https://docs.fish.audio/llms.txthttps://docs.fish.audio/llms-full.txtThe references were added to the two most relevant entry points for agent users:
developer-guide/resources/agent-quickstart.mdxdeveloper-guide/resources/coding-agents.mdxWhy
The site already provides these endpoints, but they were easy to miss. Making them explicit helps agent users and RAG pipelines discover the right retrieval entry points faster and reduces unnecessary page-by-page crawling.
Impact
Readers now get a clearer path for:
llms.txtfor the curated indexllms-full.txtfor broader contextValidation
npx prettier --check developer-guide/resources/agent-quickstart.mdx developer-guide/resources/coding-agents.mdxSummary by CodeRabbit