Skip to content

Conversation

@umair-ably
Copy link
Contributor

@umair-ably umair-ably commented Dec 18, 2025

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 for claude.md, AGENTS.md, or Cursor rules
  • /docs/ai-llms/llms-txt - Documentation for the existing llms.txt file

Homepage update:

  • New tooling section with "AI & LLMs" card on the homepage linking to the new section

Navigation:

  • New section within Platform for AI & LLMs
Screenshot 2025-12-22 at 13 57 35 Screenshot 2025-12-22 at 13 57 25

Checklist

@coderabbitai
Copy link

coderabbitai bot commented Dec 18, 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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch FTF-439

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.

@umair-ably umair-ably changed the title Adds an "AI & LLMs" section to our docs FTF-439: Adds an "AI & LLMs" section to our docs Dec 18, 2025
Copy link
Contributor

@m-hulbert m-hulbert left a 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."
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, added!

@umair-ably
Copy link
Contributor Author

@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?

Screenshot 2025-12-19 at 10 55 55 Screenshot 2025-12-19 at 10 54 08 Screenshot 2025-12-19 at 10 51 19 Screenshot 2025-12-19 at 10 49 19

@AndyTWF AndyTWF added the review-app Create a Heroku review app label Dec 19, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-ftf-439-kwnd2appki7t December 19, 2025 12:15 Inactive
@m-hulbert
Copy link
Contributor

@umair-ably

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.

@umair-ably
Copy link
Contributor Author

@m-hulbert

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 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

5 participants