Confused by the documentation and examples #8659
Replies: 1 comment
-
|
This discussion was automatically locked because it has not been updated in over 30 days. If you still have questions about this topic, please ask us at community.vercel.com/ai-sdk |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hello,
Before I start, a big thank you to everyone working on the AI SDK, it's a fantastic tool and project. Apologies if my post isn't appropriate or is missing something. I'm not an experienced dev and might very well have blind spots, this is coming from a beginner trying to understand the SDK and navigate the docs to learn.
My main source of confusion is the cookbook / guides / examples provided with the documentation.
Implementation examples : most recipes in the cookbook page tell users to look at example implementations on github. For my use case, most nextjs recipes lead to this next-openai example : https://github.com/vercel/ai/tree/main/examples/next-openai
I am lost when I look inside this folder. The README says its a simple example with nextjs and openai, but the deploy with vercel doesn't work (due to 'workspace' in package.json apparently), same if I try to install it locally. And when I look inside the folder, I see tons of seemingly unrelated tests for different providers, different features of the SDK etc...
Is this nextjs openai example the central hub for showcasing implementations that are up to date for nextjs or is this a bug ?
I tried using the LLMs.txt file with coding agents like recommended to navigate the library, but it seems to skip the parts of the docs like the reference for Core and UI, includes various guides for which idk if they are V4 or V5 based and/or if they use RSC (which is experimental only if i understand the docs), and seems hard to navigate for a coding agent without some sort of navigation file because it doesn't know whats inside it and where unless it reads the 800k tokens which it cant.
My main questions to get a better grasp of how to leverage this awesome toolkit without getting confused / implementing outdated stuff :
Should I consider that most of the cookbook + recipes + templates aren't up to date / are leftovers from prior work ? If some are outdated, is there any way to know which ones / in what manner ?
If I want to start building a prototype with the V5, should I solely refer to the API reference + docs sections for Core and UI and my provider of choice ?
Is there any way to provide very specific documentation to coding agents ? The vercel mcp seems to fetch info from everywhere in vercel documentation not just the ai sdk, and context7 also doesn't give much of the valuable explanations from the official AI SDK docs when I use it, as it focuses on code snippets / skips the API reference.
Thank you in advance for any help !
Beta Was this translation helpful? Give feedback.
All reactions