-
Notifications
You must be signed in to change notification settings - Fork 45
FTF-439: Adds an "AI & LLMs" section to our docs #3042
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 |
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.
I have no comments about the content other than the one minor suggestion I made.
What I'm not so sure on is placing this as at the product-level in the navigation and putting a banner above our actual product offerings on the homepage. I wonder if it would be better placed as a section in 'Platform' and question whether we warrant it feels like it needs to be independently called out on the homepage at all?
| @@ -0,0 +1,228 @@ | |||
| --- | |||
| title: Building with LLMs | |||
| meta_description: "Learn how to use LLMs to build with Ably documentation. Access markdown versions of docs and use our LLM-optimized resources." | |||
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.
Worth adding some meta_keywords to both pages.
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.
thanks, added!
|
@m-hulbert there are a fair few examples of others following this pattern of making it as visible as possible. I also think "Platform" already breaks the rule of only having products in the left pane. The few deviations I've spotted from others tend to nest this in an even clearer section e.g. Knock nest this under Developer Tools. I'd be keen to at least "ride the wave" of making it visible on our homepage to start with, monitor traffic/usage, and then demote as needed. WDYT?
|
|
Those examples aren't quite the same as what we've gone for here by making it the top banner on the page. I'm not against advertising the section on the homepage, but I think that needs to be a 'Tooling' box perhaps where we advertise this and the CLI. I'm definitely set against having it as a full-level section in the navigation though - especially with where we're heading product-wise. We can certainly call it out more within relevant docs, such as landing pages or getting started guides. But I think the main page needs to sit under Platform. |
|
I like the idea of calling it out more on specific getting-started guides and docs pages - I'll introduce this in a later PR. I've removed the standalone section and nested it within "Platform". Likewise, introduced a Tooling section for both the CLI and LLMs callouts on the docs homepage. Images in the PR description have been updated and I've also addressed and resolved Andy's comments so we can hopefully get this merged and deployed before you leave for Christmas 🤞 |




Description
Adds a new top-level "AI & LLMs" section to the documentation, helping developers use AI assistants to build with Ably.
New documentation pages:
/docs/ai-llms- Main page explaining LLM-friendly resources and a copyable prompt forclaude.md,AGENTS.md, or Cursor rules/docs/ai-llms/llms-txt- Documentation for the existingllms.txtfileHomepage update:
Navigation:
Checklist