docs: Add FAQ section for common questions#648
Conversation
📝 WalkthroughWalkthroughThe README receives a new FAQ section that introduces TanStack AI's purpose, core features, installation instructions for different provider configurations (core+OpenAI, Anthropic, framework packages), supported providers and frameworks in tabular form, use-case examples, and a comparison against the Vercel AI SDK. ChangesREADME FAQ Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
359-367: 💤 Low valueConsider consolidating duplicated content.
The "What Can You Build?" section in the FAQ duplicates the "What You Can Build" section already present at lines 53-72. While having this content in FAQ format might help some users, this creates a maintenance burden where updates must be made in two places.
Consider either:
- Removing this subsection from the FAQ and referencing the earlier section
- Keeping only the FAQ version and removing the earlier one
- Significantly abbreviating the FAQ version to avoid near-verbatim duplication
🤖 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 359 - 367, The FAQ contains a near-duplicate "What Can You Build?" subsection that mirrors the earlier "What You Can Build" section; pick one consolidation strategy and apply it: either remove the FAQ subsection and add a brief cross-reference to the original "What You Can Build" heading, or remove the original section and keep the FAQ entry (updating any anchors/TOC), or significantly shorten the FAQ entry to a one-line summary with a link to the main "What You Can Build" section; update the README headings "What Can You Build?" and "What You Can Build" accordingly and ensure internal links/TOC anchors still point to the remaining content.
369-378: 💤 Low valueConsider adding context to the comparison table.
The comparison table provides a highly condensed summary of differences with Vercel AI SDK. Phrases like "Composable activities" vs "Monolithic helpers" and "Full inference" vs "Partial types" may be unclear without additional context.
Since a detailed comparison document already exists (linked at lines 50-51), consider adding a note directing readers to that full comparison for details, or briefly expanding the table entries.
🤖 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 369 - 378, Add a brief clarifying sentence immediately below the "TanStack AI vs Vercel AI SDK" heading/table that points readers to the existing full comparison document and/or expands the ambiguous cells; specifically reference the "TanStack AI vs Vercel AI SDK" table and update entries like "Composable activities" vs "Monolithic helpers" and "Full inference" vs "Partial types" with one-line clarifications (or a "see full comparison" link) so readers can find detailed definitions in the linked comparison document.
🤖 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 340-348: Update the "Supported Providers" table so the Package
column for Groq and Ollama use the correct package names: replace the "Custom
endpoint" entries for the Groq row with `@tanstack/ai-groq` and for the Ollama
row with `@tanstack/ai-ollama`; edit the table rows under the "Supported
Providers" heading to swap those two Package cell values accordingly.
---
Nitpick comments:
In `@README.md`:
- Around line 359-367: The FAQ contains a near-duplicate "What Can You Build?"
subsection that mirrors the earlier "What You Can Build" section; pick one
consolidation strategy and apply it: either remove the FAQ subsection and add a
brief cross-reference to the original "What You Can Build" heading, or remove
the original section and keep the FAQ entry (updating any anchors/TOC), or
significantly shorten the FAQ entry to a one-line summary with a link to the
main "What You Can Build" section; update the README headings "What Can You
Build?" and "What You Can Build" accordingly and ensure internal links/TOC
anchors still point to the remaining content.
- Around line 369-378: Add a brief clarifying sentence immediately below the
"TanStack AI vs Vercel AI SDK" heading/table that points readers to the existing
full comparison document and/or expands the ambiguous cells; specifically
reference the "TanStack AI vs Vercel AI SDK" table and update entries like
"Composable activities" vs "Monolithic helpers" and "Full inference" vs "Partial
types" with one-line clarifications (or a "see full comparison" link) so readers
can find detailed definitions in the linked comparison document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ### Supported Providers | ||
|
|
||
| | Provider | Package | Features | | ||
| |----------|---------|----------| | ||
| | **OpenAI** | `@tanstack/ai-openai` | Chat, Tools, Images, Audio | | ||
| | **Anthropic** | `@tanstack/ai-anthropic` | Claude models | | ||
| | **Groq** | Custom endpoint | Fast inference | | ||
| | **Ollama** | Custom endpoint | Local models | | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify that the Groq and Ollama packages exist
# Check for package.json files in the providers
fd -t f 'package.json' packages/ai-groq packages/ai-ollama --exec cat {} \; | jq -r '.name'Repository: TanStack/ai
Length of output: 93
Fix Supported Providers table package names for Groq and Ollama
README.md lines 346-347 incorrectly list “Custom endpoint” in the Package column; these rows should use @tanstack/ai-groq and @tanstack/ai-ollama instead.
📦 Proposed fix
| Provider | Package | Features |
|----------|---------|----------|
| **OpenAI** | `@tanstack/ai-openai` | Chat, Tools, Images, Audio |
| **Anthropic** | `@tanstack/ai-anthropic` | Claude models |
-| **Groq** | Custom endpoint | Fast inference |
-| **Ollama** | Custom endpoint | Local models |
+| **Groq** | `@tanstack/ai-groq` | Fast inference |
+| **Ollama** | `@tanstack/ai-ollama` | Local models |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Supported Providers | |
| | Provider | Package | Features | | |
| |----------|---------|----------| | |
| | **OpenAI** | `@tanstack/ai-openai` | Chat, Tools, Images, Audio | | |
| | **Anthropic** | `@tanstack/ai-anthropic` | Claude models | | |
| | **Groq** | Custom endpoint | Fast inference | | |
| | **Ollama** | Custom endpoint | Local models | | |
| ### Supported Providers | |
| | Provider | Package | Features | | |
| |----------|---------|----------| | |
| | **OpenAI** | `@tanstack/ai-openai` | Chat, Tools, Images, Audio | | |
| | **Anthropic** | `@tanstack/ai-anthropic` | Claude models | | |
| | **Groq** | `@tanstack/ai-groq` | Fast inference | | |
| | **Ollama** | `@tanstack/ai-ollama` | Local models | | |
🤖 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 340 - 348, Update the "Supported Providers" table so
the Package column for Groq and Ollama use the correct package names: replace
the "Custom endpoint" entries for the Groq row with `@tanstack/ai-groq` and for
the Ollama row with `@tanstack/ai-ollama`; edit the table rows under the
"Supported Providers" heading to swap those two Package cell values accordingly.
1 participant
This PR adds a comprehensive FAQ section covering key features, installation, providers, framework support, and comparison with Vercel AI SDK.
Summary by CodeRabbit