Skip to content

docs: add quickstart troubleshooting notes#1788

Open
dashitongzhi wants to merge 1 commit into
BuilderIO:mainfrom
dashitongzhi:docs/troubleshooting-20260702092306
Open

docs: add quickstart troubleshooting notes#1788
dashitongzhi wants to merge 1 commit into
BuilderIO:mainfrom
dashitongzhi:docs/troubleshooting-20260702092306

Conversation

@dashitongzhi

Copy link
Copy Markdown

Summary

  • Add a Quick Start validation checklist for confirming a generated Agent-Native app boots correctly.
  • Document common first-run failures around Node, pnpm, stale installs, ports, credentials, database setup, and browser-only errors.
  • Include a clean retry path for partially generated apps.

Test Plan

  • git diff --check

Copilot AI review requested due to automatic review settings July 2, 2026 01:24
@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Visual recap — skipped

The visual recap job did not run for this pull request. This is informational only and does not block the PR.

Recap skipped for 8a09aeb: external fork PR requires a maintainer to apply the recap label to the current head SHA.

@builder-io-integration builder-io-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@steve8708

Copy link
Copy Markdown
Contributor

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?

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.

3 participants