docs: add quickstart troubleshooting notes#1788
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Visual recap — skippedThe visual recap job did not run for this pull request. This is informational only and does not block the PR. Recap skipped for |
There was a problem hiding this comment.
Builder reviewed your changes and has a few items to flag 🟡
Review Details
This PR adds a Quick Start validation checklist plus first-run troubleshooting guidance to README.md. The overall approach is good: it gives new users a concrete smoke test after pnpm dev and a clean retry path instead of encouraging ad hoc edits to partially generated apps.
Risk assessment: low. The diff is documentation-only, but the new troubleshooting bullets need to match scaffolded project behavior exactly because they will be used when users are already blocked. I found two accuracy issues in that guidance: 🟡 the Node-version bullet points readers at package.json, even though some generated workspace roots do not declare engines.node and the repo also carries a separate .nvmrc; 🟡 the credentials bullet says to check a generated .env file, but common scaffold paths ship .env.example and require users to create .env themselves. Aside from those details, the validation checklist itself is practical and well-targeted.
🧪 Browser testing: Skipped — PR only modifies backend/config/docs, no UI impact
|
thanks @dashitongzhi! I'm not sure right on the main README is the best place for this. maybe add a separate troubleshooting doc and we can link to it from the readme? |
Summary
Test Plan
git diff --check