docs: add AI Transport cross-references to key pages#3221
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
mattheworiordan
requested review from
m-hulbert,
mschristensen and
umair-ably
|
Somewhat related: a Markdown variant of our documentation pages, optimized for LLM consumption, now includes related topics within the navigation footer → #3208 |
|
The update on the Channels page feels a little bit shoe-horned in, but I don't hate it. The other changes all look good. |
AI Transport was missing from several high-visibility pages including the About Ably page, the Building with LLMs page, the llms.txt preamble, and the channels concept page. This adds light cross- references where there's a clear use case without polluting unrelated Pub/Sub documentation.
Remove the shoehorned placement after the channel groups section and add cross-references where developers are actively doing something relevant: after the publish code examples on the pub-sub page, and after the SSE advantages comparison.
m-hulbert
force-pushed
the
feat/add-ai-transport-mentions
branch
from
e0bbed7 to
15337a8
Compare
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Fixed conflicts and LGTM now 👍
5 participants
AI Transport is Ably's strategic priority but was missing from several high-visibility page. The About Ably page lists every product except it, the Building with LLMs page (literally about AI) doesn't mention it, and the llms.txt preamble omits it entirely. This PR adds light cross-references where there's a clear use case.
Changes
platform/index.mdx): Added AI Transport product section after LiveSync, following the established pattern of the other product entriesai-llms/index.mdx): Added an Aside note pointing to AI Transport, plus added AI Transport to both the product priority list and interface list in the LLM configuration promptllmstxt.ts): Added "AI Transport" to the products listllms-txt.mdx): Added AI Transport category description alongside the other productsconnection-recovery.mdx): Added a paragraph linking connection recovery to AI Transport's resumable token streaming — this is the exact mechanism AI Transport builds on, so it's a natural fitchannels/index.mdx): Added afurther-readingaside at the bottom of the pagePlacement trade-offs
Building with LLMs page - added an aside as the page is about using LLM coding assistants to build with Ably docs, not about AI Transport itself, but obviously could end up being a target for AI devs who click that form docs home page.
Channels page - added a
further-readingaside. The intro explains channel concepts and jumping straight to "btw, AI Transport" felt premature. At the end, the reader has full context on what channels are and the cross-reference reads as "you might also want to know" rather than an interruption.