Skip to content

Commit 3f58156

Browse files
m-hulbertm-hulbert
authored
Merge pull request #3313 from ably/experiment/ait-docs-ia
Restructure AI Transport documentation information architecture
2 parents 65e6119 + 2b93f1f commit 3f58156

File tree

73 files changed

+4769
-18971
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+4769
-18971
lines changed

‎src/data/nav/aitransport.ts‎

Lines changed: 108 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -9,186 +9,175 @@ export default {
99
},
1010
content: [
1111
{
12-
name: 'About AI Transport',
12+
name: 'Overview',
1313
link: '/docs/ai-transport',
1414
index: true,
1515
},
1616
{
17-
name: 'Getting started',
17+
name: 'Why AI Transport',
18+
link: '/docs/ai-transport/why',
19+
},
20+
{
21+
name: 'How it works',
1822
pages: [
1923
{
20-
name: 'Anthropic',
21-
link: '/docs/ai-transport/getting-started/anthropic',
24+
name: 'Sessions and turns',
25+
link: '/docs/ai-transport/how-it-works/sessions-and-turns',
2226
},
2327
{
24-
name: 'OpenAI',
25-
link: '/docs/ai-transport/getting-started/openai',
28+
name: 'Transport',
29+
link: '/docs/ai-transport/how-it-works/transport',
2630
},
31+
{
32+
name: 'Authentication',
33+
link: '/docs/ai-transport/how-it-works/authentication',
34+
},
35+
],
36+
},
37+
{
38+
name: 'Getting started',
39+
pages: [
2740
{
2841
name: 'Vercel AI SDK',
2942
link: '/docs/ai-transport/getting-started/vercel-ai-sdk',
3043
},
44+
],
45+
},
46+
{
47+
name: 'Framework guides',
48+
pages: [
3149
{
32-
name: 'LangGraph',
33-
link: '/docs/ai-transport/getting-started/langgraph',
50+
name: 'Vercel AI SDK',
51+
link: '/docs/ai-transport/framework-guides/vercel-ai-sdk',
3452
},
3553
],
3654
},
3755
{
38-
name: 'Token streaming',
56+
name: 'Features',
3957
pages: [
4058
{
41-
name: 'Overview',
42-
link: '/docs/ai-transport/token-streaming',
43-
index: true,
59+
name: 'Token streaming',
60+
link: '/docs/ai-transport/features/token-streaming',
4461
},
4562
{
46-
name: 'Message per response',
47-
link: '/docs/ai-transport/token-streaming/message-per-response',
63+
name: 'Cancellation',
64+
link: '/docs/ai-transport/features/cancellation',
4865
},
4966
{
50-
name: 'Message per token',
51-
link: '/docs/ai-transport/token-streaming/message-per-token',
67+
name: 'Reconnection and recovery',
68+
link: '/docs/ai-transport/features/reconnection-and-recovery',
5269
},
5370
{
54-
name: 'Token streaming limits',
55-
link: '/docs/ai-transport/token-streaming/token-rate-limits',
71+
name: 'Multi-device sessions',
72+
link: '/docs/ai-transport/features/multi-device',
5673
},
57-
],
58-
},
59-
{
60-
name: 'Sessions & Identity',
61-
pages: [
6274
{
63-
name: 'Overview',
64-
link: '/docs/ai-transport/sessions-identity',
75+
name: 'History and replay',
76+
link: '/docs/ai-transport/features/history',
77+
},
78+
{
79+
name: 'Conversation branching',
80+
link: '/docs/ai-transport/features/branching',
6581
},
6682
{
67-
name: 'Identifying users and agents',
68-
link: '/docs/ai-transport/sessions-identity/identifying-users-and-agents',
83+
name: 'Interruption and barge-in',
84+
link: '/docs/ai-transport/features/interruption',
6985
},
7086
{
71-
name: 'Online status',
72-
link: '/docs/ai-transport/sessions-identity/online-status',
87+
name: 'Concurrent turns',
88+
link: '/docs/ai-transport/features/concurrent-turns',
89+
},
90+
{
91+
name: 'Edit and regenerate',
92+
link: '/docs/ai-transport/features/edit-and-regenerate',
93+
},
94+
{
95+
name: 'Tool calling',
96+
link: '/docs/ai-transport/features/tool-calling',
97+
},
98+
{
99+
name: 'Human-in-the-loop',
100+
link: '/docs/ai-transport/features/human-in-the-loop',
101+
},
102+
{
103+
name: 'Optimistic updates',
104+
link: '/docs/ai-transport/features/optimistic-updates',
105+
},
106+
{
107+
name: 'Agent presence',
108+
link: '/docs/ai-transport/features/agent-presence',
73109
},
74110
{
75111
name: 'Push notifications',
76-
link: '/docs/ai-transport/sessions-identity/push-notifications',
112+
link: '/docs/ai-transport/features/push-notifications',
113+
},
114+
{
115+
name: 'Chain of thought',
116+
link: '/docs/ai-transport/features/chain-of-thought',
77117
},
78118
{
79-
name: 'Resuming sessions',
80-
link: '/docs/ai-transport/sessions-identity/resuming-sessions',
119+
name: 'Double texting',
120+
link: '/docs/ai-transport/features/double-texting',
81121
},
82122
],
83123
},
84124
{
85-
name: 'Messaging',
125+
name: 'API reference',
86126
pages: [
87127
{
88-
name: 'Accepting user input',
89-
link: '/docs/ai-transport/messaging/accepting-user-input',
128+
name: 'Overview',
129+
link: '/docs/ai-transport/api-reference',
130+
index: true,
131+
},
132+
{
133+
name: 'Client transport',
134+
link: '/docs/ai-transport/api-reference/client-transport',
90135
},
91136
{
92-
name: 'Tool calls',
93-
link: '/docs/ai-transport/messaging/tool-calls',
137+
name: 'Server transport',
138+
link: '/docs/ai-transport/api-reference/server-transport',
94139
},
95140
{
96-
name: 'Human-in-the-loop',
97-
link: '/docs/ai-transport/messaging/human-in-the-loop',
141+
name: 'React hooks',
142+
link: '/docs/ai-transport/api-reference/react-hooks',
98143
},
99144
{
100-
name: 'Chain of thought',
101-
link: '/docs/ai-transport/messaging/chain-of-thought',
145+
name: 'Vercel integration',
146+
link: '/docs/ai-transport/api-reference/vercel',
102147
},
103148
{
104-
name: 'Citations',
105-
link: '/docs/ai-transport/messaging/citations',
149+
name: 'Codec',
150+
link: '/docs/ai-transport/api-reference/codec',
106151
},
107152
{
108-
name: 'Completion and cancellation',
109-
link: '/docs/ai-transport/messaging/completion-and-cancellation',
153+
name: 'Error codes',
154+
link: '/docs/ai-transport/api-reference/error-codes',
110155
},
111156
],
112157
},
113158
{
114-
name: 'Guides',
115-
expand: true,
159+
name: 'Internals',
116160
pages: [
117161
{
118-
name: 'Anthropic',
119-
pages: [
120-
{
121-
name: 'Message per response',
122-
link: '/docs/ai-transport/guides/anthropic/anthropic-message-per-response',
123-
},
124-
{
125-
name: 'Message per token',
126-
link: '/docs/ai-transport/guides/anthropic/anthropic-message-per-token',
127-
},
128-
{
129-
name: 'Human-in-the-loop',
130-
link: '/docs/ai-transport/guides/anthropic/anthropic-human-in-the-loop',
131-
},
132-
{
133-
name: 'Citations',
134-
link: '/docs/ai-transport/guides/anthropic/anthropic-citations',
135-
},
136-
],
137-
},
138-
{
139-
name: 'OpenAI',
140-
pages: [
141-
{
142-
name: 'Message per response',
143-
link: '/docs/ai-transport/guides/openai/openai-message-per-response',
144-
},
145-
{
146-
name: 'Message per token',
147-
link: '/docs/ai-transport/guides/openai/openai-message-per-token',
148-
},
149-
{
150-
name: 'Human-in-the-loop',
151-
link: '/docs/ai-transport/guides/openai/openai-human-in-the-loop',
152-
},
153-
{
154-
name: 'Citations',
155-
link: '/docs/ai-transport/guides/openai/openai-citations',
156-
},
157-
],
158-
},
159-
{
160-
name: 'LangGraph',
161-
pages: [
162-
{
163-
name: 'Message per response',
164-
link: '/docs/ai-transport/guides/langgraph/langgraph-message-per-response',
165-
},
166-
{
167-
name: 'Message per token',
168-
link: '/docs/ai-transport/guides/langgraph/langgraph-message-per-token',
169-
},
170-
{
171-
name: 'Human-in-the-loop',
172-
link: '/docs/ai-transport/guides/langgraph/langgraph-human-in-the-loop',
173-
},
174-
],
162+
name: 'Overview',
163+
link: '/docs/ai-transport/internals',
164+
index: true,
175165
},
176166
{
177-
name: 'Vercel AI SDK',
178-
pages: [
179-
{
180-
name: 'Message per response',
181-
link: '/docs/ai-transport/guides/vercel-ai-sdk/vercel-message-per-response',
182-
},
183-
{
184-
name: 'Message per token',
185-
link: '/docs/ai-transport/guides/vercel-ai-sdk/vercel-message-per-token',
186-
},
187-
{
188-
name: 'Human-in-the-loop',
189-
link: '/docs/ai-transport/guides/vercel-ai-sdk/vercel-human-in-the-loop',
190-
},
191-
],
167+
name: 'Wire protocol',
168+
link: '/docs/ai-transport/internals/wire-protocol',
169+
},
170+
{
171+
name: 'Codec architecture',
172+
link: '/docs/ai-transport/internals/codec-architecture',
173+
},
174+
{
175+
name: 'Conversation tree',
176+
link: '/docs/ai-transport/internals/conversation-tree',
177+
},
178+
{
179+
name: 'Transport patterns',
180+
link: '/docs/ai-transport/internals/transport-patterns',
192181
},
193182
],
194183
},

‎src/images/content/diagrams/ai-transport-multi-device-co-pilots-architecture.png‎

31.8 KB
Loading

‎src/images/content/diagrams/ait-feature-appends.png‎

66 KB
Loading

‎src/images/content/diagrams/ait-presence-aware.png‎

25.4 KB
Loading

‎src/images/content/diagrams/ait-session-continuity.png‎

85.5 KB
Loading

0 commit comments

Comments
 (0)