Commit 2beb1d5
committed
docs(ai-chat): unblock check-broken-links + address PR #3226 review feedback
- Replace `### chat.history {#chat-history}` and `## chat.defer() {#chat-defer}`
with sentence-case headings ("Chat history", "Chat defer"). Mintlify's MDX
parser couldn't parse the `{#...}` explicit-anchor syntax — `{...}` is JSX
expression syntax in MDX, and `#chat-history` is not a valid expression. The
sentence-case slug matches the existing cross-references on `/ai-chat/backend#chat-history`
and `/ai-chat/features#chat-defer`.
- Fix the dead link to `/ai-chat/skills/overview` in patterns/skills.mdx by
reframing as descriptive text instead.
Review feedback (CodeRabbit on PR #3226):
- backend.mdx persistence example: add a `<Warning>` callout reminding readers
to scope every server action by the authenticated user (`where: { userId }`)
before pasting into a real multi-user app. The example keeps auth out of the
way to focus on the persistence shape; the warning makes the gap explicit.
- features.mdx `chat.local` example: `userContext.get().userId` was read later
but `userId` wasn't part of the type or init — added it to both.
- features.mdx preload example: missing `import { useEffect } from "react";`.
- frontend.mdx restoring-on-page-load example: relabel `app/page.tsx` to
`app/chat/[chatId]/ChatPage.tsx`. The exported `ChatPage` is a client
component that takes `chatId` as a normal prop — not an App Router page,
which would receive `params`. Added a comment showing the trivial server-
component wrapper that awaits `params` and forwards `chatId` into it.
Internal "Phase 1/2/3" language stripped from skills.mdx and changelog.mdx —
roadmap-internal terminology that doesn't mean anything to readers.1 parent 0de87db commit 2beb1d5
5 files changed
Lines changed: 22 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
619 | 619 | | |
620 | 620 | | |
621 | 621 | | |
| 622 | + | |
| 623 | + | |
| 624 | + | |
| 625 | + | |
622 | 626 | | |
623 | 627 | | |
624 | 628 | | |
| |||
905 | 909 | | |
906 | 910 | | |
907 | 911 | | |
908 | | - | |
| 912 | + | |
909 | 913 | | |
910 | 914 | | |
911 | 915 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| 28 | + | |
28 | 29 | | |
29 | 30 | | |
30 | 31 | | |
| |||
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
| 43 | + | |
42 | 44 | | |
43 | 45 | | |
44 | 46 | | |
| |||
158 | 160 | | |
159 | 161 | | |
160 | 162 | | |
161 | | - | |
| 163 | + | |
162 | 164 | | |
163 | 165 | | |
164 | 166 | | |
| |||
426 | 428 | | |
427 | 429 | | |
428 | 430 | | |
| 431 | + | |
429 | 432 | | |
430 | 433 | | |
431 | 434 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| |||
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
142 | 149 | | |
143 | 150 | | |
144 | 151 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| |||
197 | 197 | | |
198 | 198 | | |
199 | 199 | | |
200 | | - | |
| 200 | + | |
201 | 201 | | |
202 | | - | |
| 202 | + | |
203 | 203 | | |
204 | | - | |
| 204 | + | |
205 | 205 | | |
206 | 206 | | |
207 | 207 | | |
| |||
0 commit comments