-
Notifications
You must be signed in to change notification settings - Fork 46
[EDU-2101] - Update llmstxt.ts to structure llms.txt a bit cleaner #2891
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
base: main
Are you sure you want to change the base?
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ 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 |
kennethkalmer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GregHolmes should we even have asset tracking in here since it is being deprecated?
m-hulbert
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really great idea, Greg.
There's a few tweaks I think we need to make to Platform and Pub/Sub and I also wonder if we should look at breaking down other products too (at least maybe Chat and LiveObjects) into further categories. WDYT?
95613e3 to
69fad7b
Compare
Yes and no, I think, until we actually deprecate it we should keep it. Then remove when the big changes are made. |
m-hulbert
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks a lot better, just a few things:
- All the Pub/Sub API refs (+ REST API) are mixed in together (and REST and realtime have pages named the same thing, so it's quite confusing).
- Control API reference is missing.
- Some pages aren't generating in multiple langs (e.g. basic auth)
563c3da to
d8e9d91
Compare
Description
Restructured llms.txt generation with product categorisation This update reorganises the generated llms.txt file from a flat list into a structured hierarchy with categories (Platform, Pub/Sub, Chat, Spaces, LiveObjects, LiveSync, Asset Tracking) and subcategories based on URL patterns. Added a more informative preamble describing Ably's core features, support for Kotlin and React languages, and logic to skip redundant language-specific URLs when the language already matches the page slug (e.g., prevents /getting-started/go?lang=go). The structured format improves LLM navigation and discovery of relevant documentation.
Attached an example of the llms.txt generated:
llms.txt
Build output: