Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LLMs.txt #2497

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

LLMs.txt #2497

wants to merge 3 commits into from

Conversation

mattheworiordan
Copy link
Member

See https://llmstxt.site/ for context.

Modern AI friendly tools provide llms.txt files for LLMs.

This script simply calls out to Firecrawl and generates an LLMs.txt file. However, it is not working as expected and some additional work is needed:

  • Crawlers cannot crawl all languages, we need better discovery, perhaps an index page with all languages, and we need to understand why crawlers are not selecting different languages (should these be hyperlinks).
  • llms.txt needs to be served from ably.com, not ably.com/docs (website should be able to easily proxy this)
  • There are issues with language selection where if you select Node.js, navigate to a page that does not support Node.js, and then navigate to one that does, it remains on JS. This means we're losing the language selection for crawlers too. See GIF below.

MO screenshot 2025-03-27 at 23 53 11

See https://docs.firecrawl.dev/features/alpha/llmstxt.

This work identified a number of issues:
- Crawlers cannot crawl all languages, we need better discovery
- llms.txt needs to be served from ably.com, not ably.com/docs
- There are issues with language selection where if you select Node.js, navigate to a page that does not support Node.js, and then navigate to one that does, it remains on JS. This means we're losing the language selection for crawlers too.
Copy link

coderabbitai bot commented Mar 28, 2025

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.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ably-ci ably-ci temporarily deployed to ably-docs-llms-txt-29aqcj1zewj March 28, 2025 00:11 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-llms-txt-29aqcj1zewj March 28, 2025 14:07 Inactive
Copy link
Member

@kennethkalmer kennethkalmer left a comment

Choose a reason for hiding this comment

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

I get the intent, this is pretty cool, but in practice this won't work well and the reason is it will always be behind the current PR. We cannot update the text file with the updates from the PR because the PR has not been deployed yet...

That said, I wonder if we cannot simply attempt to create a build step that simply slurps up all the HTML files in public, extracts the elements under a certain selector (so we don't get the navigation elements) and renders it out as a huge text file (or as mutliple text files), and then we could even solve the language problem because we understand the markup

Copy link
Member

@jamiehenson jamiehenson left a comment

Choose a reason for hiding this comment

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

So to get my head into this - Firecrawl takes an entry point, crawls from there, and spits out a markdown file consisting of crawled links and a one-line synopsis of the contents that's generated through some LLM-ish means.

As part of the nav rewrite we made the data foundations of the pages more accessible. To achieve what you ask here re: languages, we could compile a matrix of pages (pubsub ones as an example here) and languages per product into a page and point firecrawl at that.

To be honest, this would get us most of the way there, by looping in the meta descriptions currently on the textile documents we pretty much have what Firecrawl provides without the need for another service.

Alternatively, lightest approach could be to hide some links on each page pointing to each available language variant, but this would fall apart if Firecrawl assesses the visibility of links in its traversal.

@paddybyers
Copy link
Member

Is this mergeable?

@m-hulbert
Copy link
Contributor

@kennethkalmer did you have a chance to look at proxying this if we merge, and/or the scope of work required to generate the files Jamie mentioned?

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.

7 participants