docs: rebuild README evaluator journey - #267
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 33eac3587c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| pnpm dlx shadcn@4.19.1 init --base radix --preset nova --css-variables | ||
| pnpm dlx shadcn@4.19.1 add button dropdown-menu sonner --yes |
There was a problem hiding this comment.
Include next-themes in the quickstart prerequisites
For a clean existing Next.js app where shadcn/ui was not previously configured, these commands do not install next-themes, but the generator always emits components/mode-toggle.tsx, which imports useTheme from that package (packages/cli/src/templates/shared/components/mode-toggle.tsx:4). The generator's dependency installer also omits it (packages/cli/src/utils/package-installer.ts:46-53), so following the advertised path leaves the generated project failing typechecking/production builds with Cannot find module 'next-themes'; add it to this prerequisite install sequence or have codegen install it.
Useful? React with 👍 / 👎.
Closes #261
Why
The previous README led with implementation detail before a first-time visitor could tell what BTST is, what a plugin installs, where it fits, or what they keep. This rewrite turns the README into an evaluator journey while keeping detailed setup in canonical docs.
What changed
/pages/blogas the visible success conditionClean-project provenance
Verified on Node.js 22.23.2 in a fresh Next.js 16.2.6 App Router project using public packages:
Observed result: the generated production app loaded
/pages/blog, rendered theBlog Postsheading and empty-state UI, had no horizontal overflow, and produced no browser console/page errors.Two clean-room checks narrowed the documented path:
@hookform/resolversand rejectedbetter-call's Zod 4 peer requirement; this README therefore documents the verified pnpm path rather than claiming npm parity.DropdownMenuTrigger asChildbuild contract; the README now gives the exact pinned Radix initialization used by the passing build.These findings do not change package or generator behavior in this PR.
Verification
pnpm check:product-proof— 8 assets, 206,291 bytespnpm test:product-proof— 10/10 passingpnpm lint— canonical DX guard and Biome pass (Node.js 22.23.2)git diff --checkScope and future context