docs: refresh README and package metadata#626
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR adds OpenRouter web_fetch tool metadata, replaces README copy shell commands with a Node copy script, rewrites the root README and many package READMEs, and expands package.json description/keyword metadata across the TypeScript packages. ChangesDocumentation and Metadata Ecosystem Refresh
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a 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 |
Contributor
🚀 Changeset Version Preview31 package(s) bumped directly, 0 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
|
View your CI Pipeline Execution ↗ for commit a330fd8
☁️ Nx Cloud last updated this comment at |
@tanstack/ai
@tanstack/ai-anthropic
@tanstack/ai-client
@tanstack/ai-code-mode
@tanstack/ai-code-mode-skills
@tanstack/ai-devtools-core
@tanstack/ai-elevenlabs
@tanstack/ai-event-client
@tanstack/ai-fal
@tanstack/ai-gemini
@tanstack/ai-grok
@tanstack/ai-groq
@tanstack/ai-isolate-cloudflare
@tanstack/ai-isolate-node
@tanstack/ai-isolate-quickjs
@tanstack/ai-ollama
@tanstack/ai-openai
@tanstack/ai-openrouter
@tanstack/ai-preact
@tanstack/ai-react
@tanstack/ai-react-ui
@tanstack/ai-solid
@tanstack/ai-solid-ui
@tanstack/ai-svelte
@tanstack/ai-utils
@tanstack/ai-vue
@tanstack/ai-vue-ui
@tanstack/openai-base
@tanstack/preact-ai-devtools
@tanstack/react-ai-devtools
@tanstack/solid-ai-devtools
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 36: The heading "Read the docs ->" currently uses a third-level heading
(###) immediately after a top-level heading, violating heading hierarchy
(MD001); update that heading to a second-level heading by replacing the `###`
with `##` so the README maintains incremental heading levels and proper
structure.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: da6b210f-e3cb-422f-b3b2-532875c1d052
📒 Files selected for processing (34)
.changeset/openrouter-web-fetch-tool-types.mdREADME.mdpackages/typescript/ai-anthropic/package.jsonpackages/typescript/ai-client/package.jsonpackages/typescript/ai-code-mode-skills/package.jsonpackages/typescript/ai-code-mode/package.jsonpackages/typescript/ai-devtools/package.jsonpackages/typescript/ai-elevenlabs/package.jsonpackages/typescript/ai-event-client/package.jsonpackages/typescript/ai-fal/package.jsonpackages/typescript/ai-gemini/package.jsonpackages/typescript/ai-grok/package.jsonpackages/typescript/ai-groq/package.jsonpackages/typescript/ai-isolate-cloudflare/package.jsonpackages/typescript/ai-isolate-node/package.jsonpackages/typescript/ai-isolate-quickjs/package.jsonpackages/typescript/ai-ollama/package.jsonpackages/typescript/ai-openai/package.jsonpackages/typescript/ai-openrouter/package.jsonpackages/typescript/ai-openrouter/src/model-meta.tspackages/typescript/ai-preact/package.jsonpackages/typescript/ai-react-ui/package.jsonpackages/typescript/ai-react/package.jsonpackages/typescript/ai-solid-ui/package.jsonpackages/typescript/ai-solid/package.jsonpackages/typescript/ai-svelte/package.jsonpackages/typescript/ai-utils/package.jsonpackages/typescript/ai-vue-ui/package.jsonpackages/typescript/ai-vue/package.jsonpackages/typescript/ai/package.jsonpackages/typescript/openai-base/package.jsonpackages/typescript/preact-ai-devtools/package.jsonpackages/typescript/react-ai-devtools/package.jsonpackages/typescript/solid-ai-devtools/package.json
AlemTuzlak
force-pushed
the
docs/github-discoverability-readme
branch
from
f6b49d4 to
49d114b
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 294-295: The anchor label shows "TanStack Start" but its href
incorrectly points to the Router repo; update the <a href="..."><b>TanStack
Start</b></a> link so the href targets the TanStack Start repository (e.g.,
change href to the proper TanStack Start URL such as
https://github.com/tanstack/start) while preserving the bold label and
surrounding text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 683dc676-9e6c-4200-8ea3-461ae9b8dec4
📒 Files selected for processing (34)
.changeset/openrouter-web-fetch-tool-types.mdREADME.mdpackages/typescript/ai-anthropic/package.jsonpackages/typescript/ai-client/package.jsonpackages/typescript/ai-code-mode-skills/package.jsonpackages/typescript/ai-code-mode/package.jsonpackages/typescript/ai-devtools/package.jsonpackages/typescript/ai-elevenlabs/package.jsonpackages/typescript/ai-event-client/package.jsonpackages/typescript/ai-fal/package.jsonpackages/typescript/ai-gemini/package.jsonpackages/typescript/ai-grok/package.jsonpackages/typescript/ai-groq/package.jsonpackages/typescript/ai-isolate-cloudflare/package.jsonpackages/typescript/ai-isolate-node/package.jsonpackages/typescript/ai-isolate-quickjs/package.jsonpackages/typescript/ai-ollama/package.jsonpackages/typescript/ai-openai/package.jsonpackages/typescript/ai-openrouter/package.jsonpackages/typescript/ai-openrouter/src/model-meta.tspackages/typescript/ai-preact/package.jsonpackages/typescript/ai-react-ui/package.jsonpackages/typescript/ai-react/package.jsonpackages/typescript/ai-solid-ui/package.jsonpackages/typescript/ai-solid/package.jsonpackages/typescript/ai-svelte/package.jsonpackages/typescript/ai-utils/package.jsonpackages/typescript/ai-vue-ui/package.jsonpackages/typescript/ai-vue/package.jsonpackages/typescript/ai/package.jsonpackages/typescript/openai-base/package.jsonpackages/typescript/preact-ai-devtools/package.jsonpackages/typescript/react-ai-devtools/package.jsonpackages/typescript/solid-ai-devtools/package.json
✅ Files skipped from review due to trivial changes (24)
- packages/typescript/ai-openai/package.json
- packages/typescript/ai-client/package.json
- packages/typescript/ai-gemini/package.json
- packages/typescript/ai-event-client/package.json
- packages/typescript/react-ai-devtools/package.json
- packages/typescript/ai-utils/package.json
- .changeset/openrouter-web-fetch-tool-types.md
- packages/typescript/ai-preact/package.json
- packages/typescript/ai-vue-ui/package.json
- packages/typescript/ai-grok/package.json
- packages/typescript/ai-ollama/package.json
- packages/typescript/ai-react-ui/package.json
- packages/typescript/ai-solid/package.json
- packages/typescript/ai-vue/package.json
- packages/typescript/ai-svelte/package.json
- packages/typescript/ai-openrouter/package.json
- packages/typescript/ai-elevenlabs/package.json
- packages/typescript/ai-fal/package.json
- packages/typescript/preact-ai-devtools/package.json
- packages/typescript/ai-groq/package.json
- packages/typescript/ai-code-mode/package.json
- packages/typescript/ai-isolate-node/package.json
- packages/typescript/ai-devtools/package.json
- packages/typescript/ai/package.json
AlemTuzlak
force-pushed
the
docs/github-discoverability-readme
branch
from
49d114b to
cb1d53c
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
package.json (1)
8-8:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winIncorrect pnpm version specified.
The
packageManagerfield specifiespnpm@11.1.1, but the coding guidelines requirepnpm@10.17.0for this monorepo.📦 Proposed fix
- "packageManager": "pnpm@11.1.1", + "packageManager": "pnpm@10.17.0",As per coding guidelines: Use pnpm@10.17.0 as the package manager for this monorepo.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@package.json` at line 8, The packageManager entry currently sets "pnpm@11.1.1" but the monorepo requires pnpm@10.17.0; update the package.json packageManager field (the "packageManager" property) to "pnpm@10.17.0" so the project uses the correct pnpm version.
♻️ Duplicate comments (12)
packages/typescript/ai-client/README.md (2)
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (same issue as root README).
Same incorrect repository link as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-client/README.md` around lines 295 - 296, The anchor for "<b>TanStack Start</b>" in the README has the wrong href (currently pointing to the router repo); update the link URL to the correct TanStack Start repository (replace the href value on the "<b>TanStack Start</b>" anchor so it points to the official Start repo, e.g. the tanstack/start GitHub URL) so the README link is correct—this same change should mirror the fix made in the root README.
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (same issue as root README).
Same heading hierarchy violation as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-client/README.md` at line 36, The heading "### Read the docs ->" in packages/typescript/ai-client/README.md has an incorrect level; update the markdown heading token for the "Read the docs ->" line to match the corrected root README heading level (e.g., change "###" to "##" or whatever level you used in the root README) so the hierarchy is consistent; ensure the exact heading text "Read the docs ->" is updated and that other copied headings in this file follow the same corrected levels as in the root README.README.md (2)
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (duplicate of previous review).
The
###heading directly after a#heading violates markdown hierarchy (MD001). This was previously flagged and marked as addressed in commit cb1d53c, but the issue persists in the current code.📝 Proposed fix
-### <a href="https://tanstack.com/ai">Read the docs -></a> +## <a href="https://tanstack.com/ai">Read the docs -></a>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 36, The README has a top-level heading followed immediately by a third-level heading ("### <a href=\"https://tanstack.com/ai\">Read the docs -></a>") which breaks markdown hierarchy; change that heading to the correct level (e.g., "##" or match the preceding heading level) so it is not a duplicate/subordinate to the initial "#" heading and update the line containing the "Read the docs ->" anchor accordingly.
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (duplicate of previous review).
The link label says "TanStack Start" but the href points to the Router repository.
🔗 Proposed fix
-- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> - +- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> -🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 295 - 296, The anchor link with label "TanStack Start" currently points to the Router repo URL ("https://github.com/tanstack/router"); update the href to the correct TanStack Start repository URL (e.g., "https://github.com/tanstack/start") so the link target matches the link text in the README anchor tag for "TanStack Start".packages/typescript/ai-openai/README.md (2)
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (same issue as root README).
Same incorrect repository link as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-openai/README.md` around lines 295 - 296, Update the incorrect TanStack Start link in the README by replacing the existing anchor URL that wraps the "TanStack Start" text with the correct repository URL (fix the href on the <a> tag containing "TanStack Start"), or synchronize this file with the corrected root README so the fixed link propagates automatically.
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (same issue as root README).
Same heading hierarchy violation as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-openai/README.md` at line 36, The "### Read the docs ->" heading in packages/typescript/ai-openai/README.md uses an incorrect heading level (same hierarchy violation as the root README); update the Markdown heading marker for the "Read the docs ->" line to the correct level to match the document hierarchy (e.g., change "###" to "##" or whatever level the root README uses) so the heading nesting is consistent; fixing the root README heading the same way will propagate if this file is synchronized.packages/typescript/ai-devtools/README.md (2)
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (same issue as root README).
Same incorrect repository link as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-devtools/README.md` around lines 295 - 296, The README contains an incorrect anchor linking "TanStack Start" to the tanstack/router repo; update the anchor href for the "<b>TanStack Start</b>" link so it points to the correct repository (e.g. https://github.com/tanstack/start) and keep the display text unchanged; since this file was copied from the root README, ensure the same replacement is applied here by locating the "<a href="https://github.com/tanstack/router"><b>TanStack Start</b></a>" string and replacing the href with the correct tanstack/start URL.
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (same issue as root README).
Same heading hierarchy violation as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-devtools/README.md` at line 36, The heading "### <a href="https://tanstack.com/ai">Read the docs -></a>" uses an H3 and breaks the document hierarchy; change that line to the correct level (e.g., replace the leading "###" with "##" to match the root README heading structure) and ensure the same change is applied to the root README so the copied file stays consistent.packages/typescript/ai-gemini/README.md (2)
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (same issue as root README).
Same incorrect repository link as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-gemini/README.md` around lines 295 - 296, Update the broken anchor tag that currently links to "https://github.com/tanstack/router" for the "<b>TanStack Start</b>" entry in the README: change the href to the correct repository URL (e.g. "https://github.com/tanstack/start") so the "<a href=...><b>TanStack Start</b></a>" link points to the TanStack Start repo; mirror the same fix you applied in the root README so this copied file stays consistent.
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (same issue as root README).
Same heading hierarchy violation as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-gemini/README.md` at line 36, The markdown heading "Read the docs ->" currently uses an H3 marker ("### <a href=\"https://tanstack.com/ai\">Read the docs -></a>") and violates the document's heading hierarchy; update that heading marker to the same level used in the root README (replace the "###" with the correct number of '#' characters used in root README) so the packages/typescript/ai-gemini/README.md matches the root README's heading structure.packages/typescript/ai-ollama/README.md (2)
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level (same issue as root README).
Same heading hierarchy violation as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-ollama/README.md` at line 36, The heading "### <a href="https://tanstack.com/ai">Read the docs -></a>" uses an incorrect level; update its Markdown heading level to match the repository's root README heading hierarchy (e.g., change "###" to the same level used for similar section links in root README, such as "##") so the heading levels are consistent across README files.
295-296:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix TanStack Start repository link (same issue as root README).
Same incorrect repository link as flagged in the root README. Since this file is copied from the root, fixing the root README will resolve this automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-ollama/README.md` around lines 295 - 296, The README uses the wrong repo URL for the "TanStack Start" link; locate the anchor for "TanStack Start" (the <a href=...><b>TanStack Start</b></a> reference) in packages/typescript/ai-ollama/README.md and update its href from the router repo to the correct TanStack Start repository URL (use https://github.com/tanstack/start); also make the same correction in the root README to prevent the copy from reverting this change.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/typescript/ai-openrouter/README.md`:
- Line 36: The heading "Read the docs ->" is using an h3 (###) immediately after
an h1, breaking markdown hierarchy; change that heading to h2 (##) across the
affected README files so the structure flows H1 -> H2, updating the line
containing "### <a href=\"https://tanstack.com/ai\">Read the docs -></a>" to use
"##" instead in each of the listed READMEs (ai-openrouter, ai-preact,
ai-react-ui, ai-react, ai-solid-ui, ai-vue-ui, ai-vue, ai).
In `@packages/typescript/preact-ai-devtools/README.md`:
- Line 36: The heading level jumps from "# TanStack AI" to "### <a
href=\"https://tanstack.com/ai\">Read the docs -></a>" which skips h2; update
the heading to increment by one level by changing the "### <a href=...>Read the
docs -></a>" line to "## <a href=\"https://tanstack.com/ai\">Read the docs
-></a>" (or alternatively replace that heading with a regular
paragraph/italicized link) so the README follows MD001 heading-level rules.
In `@packages/typescript/react-ai-devtools/README.md`:
- Line 36: The README has a heading level jump from the h1 "TanStack AI" to an
h3 for the "Read the docs ->" line; change that line to an h2 (i.e., use "## <a
href=\"https://tanstack.com/ai\">Read the docs -></a>") or convert it to a
regular paragraph/emphasized link so heading levels increment by one; locate the
string "Read the docs ->" in README.md and update the markdown heading marker
accordingly.
In `@packages/typescript/solid-ai-devtools/README.md`:
- Line 36: The README contains a heading that jumps from h1 ("# TanStack AI") to
an h3 ("### <a href=\"https://tanstack.com/ai\">Read the docs -></a>"); update
that line to increment heading level by one (change the leading "###" to "##")
or replace it with a regular emphasized paragraph if a subheading is not
intended, ensuring the anchor text "<a href=\"https://tanstack.com/ai\">Read the
docs -></a>" remains unchanged.
---
Outside diff comments:
In `@package.json`:
- Line 8: The packageManager entry currently sets "pnpm@11.1.1" but the monorepo
requires pnpm@10.17.0; update the package.json packageManager field (the
"packageManager" property) to "pnpm@10.17.0" so the project uses the correct
pnpm version.
---
Duplicate comments:
In `@packages/typescript/ai-client/README.md`:
- Around line 295-296: The anchor for "<b>TanStack Start</b>" in the README has
the wrong href (currently pointing to the router repo); update the link URL to
the correct TanStack Start repository (replace the href value on the
"<b>TanStack Start</b>" anchor so it points to the official Start repo, e.g. the
tanstack/start GitHub URL) so the README link is correct—this same change should
mirror the fix made in the root README.
- Line 36: The heading "### Read the docs ->" in
packages/typescript/ai-client/README.md has an incorrect level; update the
markdown heading token for the "Read the docs ->" line to match the corrected
root README heading level (e.g., change "###" to "##" or whatever level you used
in the root README) so the hierarchy is consistent; ensure the exact heading
text "Read the docs ->" is updated and that other copied headings in this file
follow the same corrected levels as in the root README.
In `@packages/typescript/ai-devtools/README.md`:
- Around line 295-296: The README contains an incorrect anchor linking "TanStack
Start" to the tanstack/router repo; update the anchor href for the "<b>TanStack
Start</b>" link so it points to the correct repository (e.g.
https://github.com/tanstack/start) and keep the display text unchanged; since
this file was copied from the root README, ensure the same replacement is
applied here by locating the "<a
href="https://github.com/tanstack/router"><b>TanStack Start</b></a>" string and
replacing the href with the correct tanstack/start URL.
- Line 36: The heading "### <a href="https://tanstack.com/ai">Read the docs
-></a>" uses an H3 and breaks the document hierarchy; change that line to the
correct level (e.g., replace the leading "###" with "##" to match the root
README heading structure) and ensure the same change is applied to the root
README so the copied file stays consistent.
In `@packages/typescript/ai-gemini/README.md`:
- Around line 295-296: Update the broken anchor tag that currently links to
"https://github.com/tanstack/router" for the "<b>TanStack Start</b>" entry in
the README: change the href to the correct repository URL (e.g.
"https://github.com/tanstack/start") so the "<a href=...><b>TanStack
Start</b></a>" link points to the TanStack Start repo; mirror the same fix you
applied in the root README so this copied file stays consistent.
- Line 36: The markdown heading "Read the docs ->" currently uses an H3 marker
("### <a href=\"https://tanstack.com/ai\">Read the docs -></a>") and violates
the document's heading hierarchy; update that heading marker to the same level
used in the root README (replace the "###" with the correct number of '#'
characters used in root README) so the packages/typescript/ai-gemini/README.md
matches the root README's heading structure.
In `@packages/typescript/ai-ollama/README.md`:
- Line 36: The heading "### <a href="https://tanstack.com/ai">Read the docs
-></a>" uses an incorrect level; update its Markdown heading level to match the
repository's root README heading hierarchy (e.g., change "###" to the same level
used for similar section links in root README, such as "##") so the heading
levels are consistent across README files.
- Around line 295-296: The README uses the wrong repo URL for the "TanStack
Start" link; locate the anchor for "TanStack Start" (the <a href=...><b>TanStack
Start</b></a> reference) in packages/typescript/ai-ollama/README.md and update
its href from the router repo to the correct TanStack Start repository URL (use
https://github.com/tanstack/start); also make the same correction in the root
README to prevent the copy from reverting this change.
In `@packages/typescript/ai-openai/README.md`:
- Around line 295-296: Update the incorrect TanStack Start link in the README by
replacing the existing anchor URL that wraps the "TanStack Start" text with the
correct repository URL (fix the href on the <a> tag containing "TanStack
Start"), or synchronize this file with the corrected root README so the fixed
link propagates automatically.
- Line 36: The "### Read the docs ->" heading in
packages/typescript/ai-openai/README.md uses an incorrect heading level (same
hierarchy violation as the root README); update the Markdown heading marker for
the "Read the docs ->" line to the correct level to match the document hierarchy
(e.g., change "###" to "##" or whatever level the root README uses) so the
heading nesting is consistent; fixing the root README heading the same way will
propagate if this file is synchronized.
In `@README.md`:
- Line 36: The README has a top-level heading followed immediately by a
third-level heading ("### <a href=\"https://tanstack.com/ai\">Read the docs
-></a>") which breaks markdown hierarchy; change that heading to the correct
level (e.g., "##" or match the preceding heading level) so it is not a
duplicate/subordinate to the initial "#" heading and update the line containing
the "Read the docs ->" anchor accordingly.
- Around line 295-296: The anchor link with label "TanStack Start" currently
points to the Router repo URL ("https://github.com/tanstack/router"); update the
href to the correct TanStack Start repository URL (e.g.,
"https://github.com/tanstack/start") so the link target matches the link text in
the README anchor tag for "TanStack Start".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e3f1fb4b-94c7-4701-8eb7-2145fe95fc7f
📒 Files selected for processing (52)
.changeset/openrouter-web-fetch-tool-types.md.changeset/refresh-readme-package-metadata.mdREADME.mdpackage.jsonpackages/typescript/ai-anthropic/package.jsonpackages/typescript/ai-client/README.mdpackages/typescript/ai-client/package.jsonpackages/typescript/ai-code-mode-skills/package.jsonpackages/typescript/ai-code-mode/package.jsonpackages/typescript/ai-devtools/README.mdpackages/typescript/ai-devtools/package.jsonpackages/typescript/ai-elevenlabs/package.jsonpackages/typescript/ai-event-client/package.jsonpackages/typescript/ai-fal/package.jsonpackages/typescript/ai-gemini/README.mdpackages/typescript/ai-gemini/package.jsonpackages/typescript/ai-grok/package.jsonpackages/typescript/ai-groq/package.jsonpackages/typescript/ai-isolate-cloudflare/package.jsonpackages/typescript/ai-isolate-node/package.jsonpackages/typescript/ai-isolate-quickjs/package.jsonpackages/typescript/ai-ollama/README.mdpackages/typescript/ai-ollama/package.jsonpackages/typescript/ai-openai/README.mdpackages/typescript/ai-openai/package.jsonpackages/typescript/ai-openrouter/README.mdpackages/typescript/ai-openrouter/package.jsonpackages/typescript/ai-preact/README.mdpackages/typescript/ai-preact/package.jsonpackages/typescript/ai-react-ui/README.mdpackages/typescript/ai-react-ui/package.jsonpackages/typescript/ai-react/README.mdpackages/typescript/ai-react/package.jsonpackages/typescript/ai-solid-ui/README.mdpackages/typescript/ai-solid-ui/package.jsonpackages/typescript/ai-solid/package.jsonpackages/typescript/ai-svelte/package.jsonpackages/typescript/ai-utils/package.jsonpackages/typescript/ai-vue-ui/README.mdpackages/typescript/ai-vue-ui/package.jsonpackages/typescript/ai-vue/README.mdpackages/typescript/ai-vue/package.jsonpackages/typescript/ai/README.mdpackages/typescript/ai/package.jsonpackages/typescript/openai-base/package.jsonpackages/typescript/preact-ai-devtools/README.mdpackages/typescript/preact-ai-devtools/package.jsonpackages/typescript/react-ai-devtools/README.mdpackages/typescript/react-ai-devtools/package.jsonpackages/typescript/solid-ai-devtools/README.mdpackages/typescript/solid-ai-devtools/package.jsonscripts/copy-readme.js
✅ Files skipped from review due to trivial changes (26)
- packages/typescript/ai-event-client/package.json
- packages/typescript/react-ai-devtools/package.json
- packages/typescript/ai-elevenlabs/package.json
- .changeset/refresh-readme-package-metadata.md
- .changeset/openrouter-web-fetch-tool-types.md
- packages/typescript/solid-ai-devtools/package.json
- packages/typescript/ai/package.json
- packages/typescript/ai-anthropic/package.json
- packages/typescript/ai-fal/package.json
- packages/typescript/ai-vue/package.json
- packages/typescript/ai-preact/package.json
- packages/typescript/ai-vue-ui/package.json
- packages/typescript/ai-client/package.json
- packages/typescript/ai-gemini/package.json
- packages/typescript/openai-base/package.json
- packages/typescript/ai-isolate-cloudflare/package.json
- packages/typescript/ai-code-mode/package.json
- packages/typescript/ai-isolate-node/package.json
- packages/typescript/ai-react/package.json
- packages/typescript/ai-openrouter/package.json
- packages/typescript/ai-utils/package.json
- packages/typescript/ai-svelte/package.json
- packages/typescript/ai-devtools/package.json
- packages/typescript/ai-solid/package.json
- packages/typescript/ai-grok/package.json
- packages/typescript/ai-isolate-quickjs/package.json
crutchcorn
approved these changes
May 22, 2026
Member
crutchcorn
left a comment
crutchcorn
left a comment
There was a problem hiding this comment.
Only reviewed the scripts folder but stamping to bypass the CODEOWNERS
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/typescript/ai-devtools/README.md (1)
97-111:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse a real OpenAI model name in examples.
The code examples reference
gpt-5.2, which does not exist. Users copying these examples will encounter API errors. Use a real model likegpt-4o,gpt-4-turbo, orgpt-3.5-turboinstead.This issue appears in all 7 README files being updated in this PR (ai-devtools, ai-gemini, ai-react-ui, ai-vue, ai-ollama, solid-ai-devtools, and ai), since they share the same content.
📝 Proposed fix for Streaming Chat example
const stream = chat({ - adapter: openaiText('gpt-5.2'), + adapter: openaiText('gpt-4o'), messages: body.messages, })📝 Proposed fix for Structured Outputs example
const person = await chat({ - adapter: openaiText('gpt-5.2'), + adapter: openaiText('gpt-4o'), messages: [{ role: 'user', content: 'Ada Lovelace, 36' }], outputSchema: Person, })Also applies to: 151-166
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/typescript/ai-devtools/README.md` around lines 97 - 111, Replace the fake model name "gpt-5.2" used in the chat example with a real OpenAI model (e.g., "gpt-4o", "gpt-4-turbo", or "gpt-3.5-turbo") so the example works; specifically update the openaiText(...) argument in the POST example (where chat(...) is called and toServerSentEventsResponse(...) returns the stream) and make the same replacement for every other README example that contains "gpt-5.2" across the set of README files mentioned.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@packages/typescript/ai-devtools/README.md`:
- Around line 97-111: Replace the fake model name "gpt-5.2" used in the chat
example with a real OpenAI model (e.g., "gpt-4o", "gpt-4-turbo", or
"gpt-3.5-turbo") so the example works; specifically update the openaiText(...)
argument in the POST example (where chat(...) is called and
toServerSentEventsResponse(...) returns the stream) and make the same
replacement for every other README example that contains "gpt-5.2" across the
set of README files mentioned.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 074dfae7-2da9-4df3-a8ad-d6b0c231e04a
📒 Files selected for processing (17)
README.mdpackages/typescript/ai-client/README.mdpackages/typescript/ai-devtools/README.mdpackages/typescript/ai-gemini/README.mdpackages/typescript/ai-ollama/README.mdpackages/typescript/ai-openai/README.mdpackages/typescript/ai-openrouter/README.mdpackages/typescript/ai-preact/README.mdpackages/typescript/ai-react-ui/README.mdpackages/typescript/ai-react/README.mdpackages/typescript/ai-solid-ui/README.mdpackages/typescript/ai-vue-ui/README.mdpackages/typescript/ai-vue/README.mdpackages/typescript/ai/README.mdpackages/typescript/preact-ai-devtools/README.mdpackages/typescript/react-ai-devtools/README.mdpackages/typescript/solid-ai-devtools/README.md
✅ Files skipped from review due to trivial changes (10)
- packages/typescript/ai-openai/README.md
- README.md
- packages/typescript/react-ai-devtools/README.md
- packages/typescript/ai-react/README.md
- packages/typescript/ai-client/README.md
- packages/typescript/ai-vue-ui/README.md
- packages/typescript/ai-openrouter/README.md
- packages/typescript/preact-ai-devtools/README.md
- packages/typescript/ai-solid-ui/README.md
- packages/typescript/ai-preact/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
copy:readmecommand with a small Node script.webFetchToolsupport and include a patch changeset.Checklist
pnpm run test:pr.Release Impact
Testing
pnpm --dir F:\projects\tanstack\ai\.claude\worktrees\docs-github-discoverability-readme run copy:readmepnpm --dir F:\projects\tanstack\ai\.claude\worktrees\docs-github-discoverability-readme exec prettier --write README.md package.json scripts/copy-readme.js .changeset/refresh-readme-package-metadata.md .changeset/openrouter-web-fetch-tool-types.md "packages/typescript/*/README.md" "packages/typescript/*/package.json" packages/typescript/ai-openrouter/src/model-meta.tspnpm --dir F:\projects\tanstack\ai\.claude\worktrees\docs-github-discoverability-readme test:docspnpm --dir F:\projects\tanstack\ai\.claude\worktrees\docs-github-discoverability-readme test:sherifpnpm --dir F:\projects\tanstack\ai\.claude\worktrees\docs-github-discoverability-readme test:prSummary by CodeRabbit
Documentation
Bug Fixes
Chores