Skip to content

docs: Improve README and onboarding instructions for local development setup#288

Open
PunyaGowdagd66 wants to merge 1 commit intoAOSSIE-Org:devfrom
PunyaGowdagd66:dev
Open

docs: Improve README and onboarding instructions for local development setup#288
PunyaGowdagd66 wants to merge 1 commit intoAOSSIE-Org:devfrom
PunyaGowdagd66:dev

Conversation

@PunyaGowdagd66
Copy link

** Overview**

This PR improves the README and onboarding documentation to make the local development setup clearer and more beginner-friendly for new contributors.

** Changes Made**

  • Updated Node.js version recommendations (v18+ recommended, v20+ preferred)
  • Added a verification step for Node.js, npm, and Git installation
  • Clarified the difference between development and production setup
  • Corrected the production build output directory to .next
  • Improved formatting and wording for better readability

** Purpose**

Several new contributors face difficulties while setting up the project locally.
These updates aim to provide clearer instructions and reduce onboarding friction.

** Type of Change**

  • Documentation update

@PunyaGowdagd66 PunyaGowdagd66 requested a review from a team as a code owner February 11, 2026 06:29
@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@PunyaGowdagd66
Copy link
Author

Hi @M4dhav,

I noticed this issue was previously assigned, but since there was no recent update, I worked on improving the README and onboarding documentation to make the local setup clearer for new contributors.

If this overlaps with ongoing work, I’m happy to make adjustments or close the PR.

Thank you.

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