docs(examples/next): expand README with setup, env vars, and feature test steps#15576
Open
Zawwarsami16 wants to merge 1 commit into
Open
docs(examples/next): expand README with setup, env vars, and feature test steps#15576Zawwarsami16 wants to merge 1 commit into
Zawwarsami16 wants to merge 1 commit into
Conversation
…test steps Closes vercel#15563. The existing README is one line. This adds: - a short summary of what the example demonstrates (persistence, SSR, resumable streams) - install + build steps from the monorepo root, matching the existing example conventions - the required env var (VERCEL_API_KEY) and optional ones (REDIS_URL, BLOB_READ_WRITE_TOKEN), with links to provisioning docs - the local dev URL - per-feature test instructions so a contributor can verify each path locally - Node.js and pnpm version notes pulled from the root package.json
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
1 participant
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.
Closes #15563.
Why
The current
examples/next/README.mdis one line:A new contributor coming to the example has to dig through
package.json,.env.local.example, andapp/api/chat/route.tsto figure out what env vars are needed, which model the example uses, how to run it, and how to actually exercise the three features (persistence, SSR, resumable streams). Issue #15563 asks for the missing setup steps.What's in this PR
Expands the README with:
pnpm install && pnpm build), matching the convention in other example READMEs (e.g.examples/express/README.md)VERCEL_API_KEY(orVERCEL_OIDC_TOKENwhen deployed on Vercel) so the AI Gateway call toopenai/gpt-5-miniworks, plus the optional ones (REDIS_URLfor resumable streams,BLOB_READ_WRITE_TOKENfor attachment uploads) with links to provisioning docspnpm devcommand and the local dev URL (http://localhost:3000)^22 || ^24 || ^26) and pnpm (10.x) version notes pulled from the rootpackage.jsonNo code changes — README only.
Test plan
app/api/chat/route.ts(model name, env vars),.env.local.example(var list), rootpackage.json(engines + packageManager).