Added deep research example #2166
Conversation
|
WalkthroughThe changes introduce a new example project guide titled "Deep research agent using Vercel's AI SDK" into the documentation. This includes adding a new 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/guides/example-projects/vercel-ai-sdk-deep-research.mdx (1)
113-113: Fix possessive pronoun usage.
Change “subscribe to it's updates” to “subscribe to its updates” for correct grammar.🧰 Tools
🪛 LanguageTool
[grammar] ~113-~113: Did you mean the possessive pronoun “its”?
Context: ...edeep-researchtask and subscribe to it's updates. Frontend (React Hook): `...(IT_S_ITS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/docs.json(13 hunks)docs/guides/example-projects/vercel-ai-sdk-deep-research.mdx(1 hunks)docs/guides/introduction.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/example-projects/vercel-ai-sdk-deep-research.mdx
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...pproach. A query is recursively expanded and the results are collected. **Key param...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...llected. Key parameters: - depth: Controls recursion levels (default: 2) ...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~113-~113: Did you mean the possessive pronoun “its”?
Context: ...e deep-research task and subscribe to it's updates. Frontend (React Hook): `...
(IT_S_ITS)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (13)
docs/docs.json (2)
13-13: Skip formatting-only array flattening.
These changes convert short arrays to single-line entries without altering any functional or navigational content.Also applies to: 38-38, 53-53, 98-98, 110-110, 164-164, 220-220, 266-266, 380-380, 401-401, 576-576
348-349: Verify new guide registration in docs.json.
The path"guides/example-projects/vercel-ai-sdk-deep-research"has been added to the Example projects list. Please ensure the MDX file exists atdocs/guides/example-projects/vercel-ai-sdk-deep-research.mdxand that the slug matches exactly.docs/guides/introduction.mdx (2)
46-56: Skip existing table formatting changes.
Stylistic adjustments to the existing rows and header have no impact on content.
57-57: Verify new example project entry.
A row for "Vercel AI SDK deep research agent" was added. Confirm that the link slug (/guides/example-projects/vercel-ai-sdk-deep-research), framework label ("Next.js"), and GitHub URL (https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-deep-research-agent) are correct and live.docs/guides/example-projects/vercel-ai-sdk-deep-research.mdx (9)
1-7: Approve frontmatter configuration.
The title, sidebarTitle, description, and tag align with other guides and follow conventions.
8-18: Approve imports and acknowledgements.
The snippet imports and acknowledgements section are correctly structured and informative.
20-39: Approve Overview and Tech stack.
The project overview and tech stack list clearly communicate the components and their roles.
40-47: Approve Features list.
The feature bullets accurately capture the agent’s capabilities and are well formatted.
49-57: Approve GitHub repo Card.
The Card component correctly links to the examples repository.
61-70: Approve orchestration tasks description.
The three-task flow is documented clearly and matches the architecture described in the guide.
71-100: Approve recursive function walkthrough.
The depth-first search example is well explained, with clear levels and sub-query flow.🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...pproach. A query is recursively expanded and the results are collected. **Key param...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...llected. Key parameters: -depth: Controls recursion levels (default: 2) ...(UNLIKELY_OPENING_PUNCTUATION)
111-123: Approve Realtime integration snippet.
The React hook usage and parsing logic align with existing Realtime examples.🧰 Tools
🪛 LanguageTool
[grammar] ~113-~113: Did you mean the possessive pronoun “its”?
Context: ...edeep-researchtask and subscribe to it's updates. Frontend (React Hook): `...(IT_S_ITS)
136-142: Verify external code references.
Ensure that each linked source file in the examples repo matches its path (e.g.,deepResearch.ts,generateReport.ts, etc.).
No description provided.