Skip to content

Update CLAUDE.md/AGENTS.md inline context to respect llms.txt#3163

Draft
sacOO7 wants to merge 2 commits intomainfrom
fix/building-with-llms-inline-context
Draft

Update CLAUDE.md/AGENTS.md inline context to respect llms.txt#3163
sacOO7 wants to merge 2 commits intomainfrom
fix/building-with-llms-inline-context

Conversation

@sacOO7
Copy link
Contributor

@sacOO7 sacOO7 commented Jan 29, 2026

Summary by CodeRabbit

  • Documentation
    • Updated AI-LLM guidance with explicit step-by-step instructions for source prioritization and lookup sequencing. Established clearer precedence hierarchy between different data sources to improve consistency in information retrieval and handling.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 29, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review

Walkthrough

This pull request restructures documentation guidance for AI-LLM behavior to enforce a prioritized source-of-truth hierarchy. It adds explicit ordering that requires fetching llms.txt as the first lookup step before treating documentation as canonical and restricting web searches to fallback-only status.

Changes

Cohort / File(s) Summary
AI-LLM Source-of-Truth Guidance
src/pages/docs/platform/ai-llms/index.mdx
Reorganizes instructions into an ordered sequence that establishes llms.txt as the primary lookup source, followed by docs as canonical reference, with web searches demoted to fallback-only status. Updates prompts and guidance sections to reflect the new precedence hierarchy.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit hops with glee, so bright,
The llms.txt now takes first flight!
Before the web search springs to play,
Consult the index first, hooray!
Truth flows in order, clean and tight! ✨

🚥 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 title clearly and specifically describes the main change: updating CLAUDE.md/AGENTS.md inline context to respect llms.txt, which directly matches the content changes.
Linked Issues check ✅ Passed The PR updates inline documentation ordering to prioritize llms.txt fetching before WebSearch, directly addressing FTF-471's requirement for llms.txt as primary source-of-truth.
Out of Scope Changes check ✅ Passed All changes are focused on reordering inline context in AI agent instructions to respect llms.txt precedence, which is directly within the scope of FTF-471.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/building-with-llms-inline-context

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.

## Source of truth: Ably Docs

For anything related to Ably (APIs, SDKs, limits, behavior, authentication, capabilities, feature availability, deprecations):
For anything related to Ably:
Copy link
Contributor Author

@sacOO7 sacOO7 Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the simplified For anything related to Ably: is much cleaner and all-encompassing, because an exhaustive list (APIs, SDKs etc) might make an LLM think if it's not in this list, maybe these rules don't apply, same behaviour was partially seen in https://github.com/ably-labs/chat-poc-kotlin/pull/12.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, extra tokens don't add any actionable information

- Use **https://ably.com/llms.txt** as the authoritative index of Ably documentation.
- Prefer to perform web searches for up to date information from the Ably Docs site.
- If your prior knowledge, assumptions, or training data conflict with the docs, **the docs always win**.
1. Always fetch **https://ably.com/llms.txt** first, this is the primary search index. Use it to identify latest documentation URLs before fetching specific pages. Do not skip this step or jump directly to web searches.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

search index - creates cognitive link: "use this instead of web search"
latest - addresses the freshness problem—LLMs shouldn't rely on stale training data for URL patterns.

Copy link
Contributor Author

@sacOO7 sacOO7 Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

authoritative implies trust/correctness but doesn't convey "use first", also second point
2. Treat **https://ably.com/docs** as the canonical source of truth already highlights ably.com as trustworthy source of information.

@sacOO7
Copy link
Contributor Author

sacOO7 commented Jan 30, 2026

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 30, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@GregHolmes GregHolmes force-pushed the fix/building-with-llms-inline-context branch from ca578ee to 669c991 Compare February 2, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants