Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore (docs): improve example content, highlighting & install snippets #1790

Merged
merged 7 commits into from
Jun 3, 2024
Merged

chore (docs): improve example content, highlighting & install snippets #1790

merged 7 commits into from
Jun 3, 2024

Conversation

agusmoles
Copy link
Contributor

@agusmoles agusmoles commented Jun 2, 2024

Hi team, I was going through the documentation of the Vercel AI SDK for RSC and I think these changes were wrong in the original documentation, as we were obtaining the data from the getWeather external function, destructuring the content but then not using the returned variables since the attributes are being hardcoded in the return statement of each one

Let me know if I got something wrong. Great tool and documentation btw! 😄

EDIT: made some more updates, described below (and in the commit msgs)

forecast,
}}
/>
<WeatherCard weather={weather} />
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will affect the highlighting (line 158) which needs to be updated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh you are right, fixed

@lgrammel
Copy link
Collaborator

lgrammel commented Jun 2, 2024

thank you!

@agusmoles
Copy link
Contributor Author

agusmoles commented Jun 2, 2024

I've also added a fix to remove an unused import that might create confusion (at least it did for me) about if that was needed or not and also typed the weather variable

@agusmoles
Copy link
Contributor Author

Added tabs to install the dependencies with the different package managers (to be consistent with other parts of the documentation like https://sdk.vercel.ai/docs/ai-sdk-core/schemas-and-zod)

@agusmoles agusmoles changed the title Fix AI SDK RSC Overview Documentation Fix AI SDK RSC Documentation Jun 2, 2024
Copy link
Collaborator

@lgrammel lgrammel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, this is very helpful!

@lgrammel lgrammel changed the title Fix AI SDK RSC Documentation chore (docs): improve example content, highlighting & install snippets Jun 3, 2024
@lgrammel lgrammel merged commit 41a86e7 into vercel:main Jun 3, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants