Skip to content

docs: fix local dev setup instructions#584

Open
jack-piplabs wants to merge 1 commit intoopenclaw:mainfrom
jack-piplabs:docs/fix-local-dev-setup
Open

docs: fix local dev setup instructions#584
jack-piplabs wants to merge 1 commit intoopenclaw:mainfrom
jack-piplabs:docs/fix-local-dev-setup

Conversation

@jack-piplabs
Copy link

Summary

  • Add Node.js v18/20/22/24 as a prerequisite (Convex backend rejects v25+)
  • Remove duplicate CONVEX_SITE_URL from .env.local example (Convex derives it from VITE_CONVEX_SITE_URL)
  • Reorder setup steps so the Convex backend starts before auth/JWT configuration
  • Add "Set backend environment variables" section explaining that AUTH_GITHUB_ID, AUTH_GITHUB_SECRET, and SITE_URL must be set via bunx convex env set, not just in .env.local
  • Make frontend port explicit (bun run dev -- --port 3000) with a note about changing it
  • Add updateGlobalStatsInternal step after seeding to refresh the cached skills count

Test plan

  • Follow the updated CONTRIBUTING.md instructions from scratch on a clean checkout
  • Verify bunx convex dev --typecheck=disable starts the backend
  • Verify bunx convex env set commands configure auth correctly
  • Verify GitHub OAuth login works after setting backend env vars
  • Verify seeded skills appear with correct count after running updateGlobalStatsInternal

- Add Node.js v18/20/22/24 prerequisite (Convex backend rejects v25+)
- Remove duplicate CONVEX_SITE_URL from .env.local example
- Reorder steps so Convex backend starts before auth/JWT setup
- Add "Set backend environment variables" section (bunx convex env set)
- Clarify that AUTH_GITHUB_ID/SECRET and SITE_URL must be set on the
  Convex backend, not just in .env.local
- Make frontend port explicit (bun run dev -- --port 3000)
- Add updateGlobalStatsInternal step after seeding
@vercel
Copy link
Contributor

vercel bot commented Mar 2, 2026

@jack-piplabs is attempting to deploy a commit to the Amantus Machina Team on Vercel.

A member of the Team first needs to authorize it.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 2, 2026

Greptile Summary

Improves the local development setup documentation with better prerequisite information, clearer environment variable handling, and more logical step ordering. Key improvements include:

  • Adds Node.js version requirement (v18/20/22/24) upfront, noting v25+ incompatibility with Convex backend
  • Reorders steps to start Convex backend before configuration (logical dependency flow)
  • Clarifies that backend environment variables (AUTH_GITHUB_ID, AUTH_GITHUB_SECRET, SITE_URL) must be set via bunx convex env set separately from .env.local
  • Makes frontend port explicit (--port 3000) with guidance on updating both frontend and backend URLs if changed
  • Adds required updateGlobalStatsInternal step after seeding to refresh cached stats
  • Removes duplicate CONVEX_SITE_URL from .env.local example (derived from VITE_CONVEX_SITE_URL)

All changes are documentation-only with no functional code modifications. The test plan confirms these instructions work end-to-end on a clean checkout.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - documentation-only changes that improve clarity and accuracy
  • Score reflects that this is a documentation-only PR with no code changes, comprehensive testing (verified on clean checkout), and logical improvements that make the setup process clearer and more accurate for new contributors
  • No files require special attention

Last reviewed commit: 22d55a9

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.

1 participant