Overview/ait 189 intro token

[GregHolmes]

Description

Adds overview pages to the documentation covering

the overall AIT product, listing the major features and linking them to other documentation
token streaming, including an overview of the proposed architecture and patterns

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[GregHolmes]

I think this looks good! (I can't approve or anything as I raised it)

@rainbowFi I've left some comments on my thoughts.

I also think we need to be careful and remember that if some of this (such as the full list of agents/frameworks) isn't available on release, we need to remove the TODO comments.

[mschristensen]

Thanks for this - I left a few comments. Taking a step back, given this is such a key piece of the offering, I feel that we can do more to describe the value proposition for token streaming over Ably. Are there ways we can explicitly enumerate the key parts of the user experience that constitute a great token streaming experience? We could then contrast those with the complexities of achievng this in a connection-oriented HTTP streaming model, and how Ably solves this out of the box.

I think there is some overlap conceptually with the Sessions & identity overview, but I think it would be okay to repeat some of that here, with a token-streaming rather than session emphasis.

Let's discuss in our catch up tomorrow :)

[mschristensen]

In general, we prefer to use single word "realtime" at Ably.
(This is not what most of the internet seems to do, but alas this is our convention)

[mschristensen]

"This is normally accomplished by streaming the tokens as the response to an HTTP request from the client."

I think this can be moved out into a new paragraph. I think the intro paragraph should focus on the description of what token streaming is before getting into how it is implemented.

Then, I would suggest colocating this statement with the content that follows after the image, since that paragraph starts by describing the weakness of this approach.

[mschristensen]

This is a bit of a wall of text, but there are some nice bits of value prop in there. Can we pull those out, perhaps into bullets?

[mschristensen]

Nice, couple of small suggestions but otherwise LGTM