Skip to content

[codex] mention llms indexes in agent docs#69

Merged
abersheeran merged 1 commit into
mainfrom
codex/mention-llms-indexes
Apr 22, 2026
Merged

[codex] mention llms indexes in agent docs#69
abersheeran merged 1 commit into
mainfrom
codex/mention-llms-indexes

Conversation

@abersheeran

@abersheeran abersheeran commented Apr 22, 2026

Copy link
Copy Markdown
Collaborator

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.txt
  • https://docs.fish.audio/llms-full.txt

The references were added to the two most relevant entry points for agent users:

  • developer-guide/resources/agent-quickstart.mdx
  • developer-guide/resources/coding-agents.mdx

Why

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:

  • starting with llms.txt for the curated index
  • falling back to llms-full.txt for broader context
  • understanding that these endpoints are first-class parts of the docs experience

Validation

  • Ran npx prettier --check developer-guide/resources/agent-quickstart.mdx developer-guide/resources/coding-agents.mdx

Summary by CodeRabbit

  • Documentation
    • Introduced "Built-In Agent Indexes" section describing available index files designed for agent implementations
    • Added recommendations on index retrieval preferences with guidance on which files to consult first for different scenarios
    • Clarified best practices for selecting appropriate indexes based on documentation scope and integration needs

@mintlify

mintlify Bot commented Apr 22, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Apr 22, 2026, 2:04 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Apr 22, 2026

Copy link
Copy Markdown

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dba15cf1-a313-40bb-af48-1871be95a316

📥 Commits

Reviewing files that changed from the base of the PR and between 489b1ba and 17cbcff.

📒 Files selected for processing (2)
  • developer-guide/resources/agent-quickstart.mdx
  • developer-guide/resources/coding-agents.mdx

📝 Walkthrough

Walkthrough

These changes update documentation to introduce two LLM-oriented index files (llms.txt and llms-full.txt) across agent-related guides. Updates include a new "Built-In Agent Indexes" section, a clarifying note about which index to prioritize, JSX formatting adjustments, and import statement style changes.

Changes

Cohort / File(s) Summary
Agent Documentation Updates
developer-guide/resources/agent-quickstart.mdx, developer-guide/resources/coding-agents.mdx
Added "Built-In Agent Indexes" section introducing llms.txt and llms-full.txt files with retrieval preferences; included explanatory <Note> component; reformatted JSX components and indentation; updated import quotes from single to double; ensured newline at end of file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • twangodev

Poem

🐰 Hop skip and a jump through docs so bright,
New indexes shine with LLM light,
Quotes and formatting now align,
Agent guides gleam by design!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and accurately reflects the main change: adding documentation about LLM-friendly indexes to agent-focused guide pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/mention-llms-indexes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@abersheeran
abersheeran marked this pull request as ready for review April 22, 2026 02:11
@abersheeran
abersheeran merged commit d1b088e into main Apr 22, 2026
3 of 4 checks passed
@abersheeran
abersheeran deleted the codex/mention-llms-indexes branch April 22, 2026 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant