good-first-issue icon indicating copy to clipboard operation
good-first-issue copied to clipboard

docs: Improve Local Setup Guide for New Contributors

Open ooBean opened this issue 2 months ago • 2 comments

The Problem

Currently, the README.md file makes a few assumptions that can be challenging for new contributors:

  1. It primarily recommends using bun, but does not provide installation instructions or alternatives like npm or yarn. This can be a blocker if bun is not installed.
  2. When setting up the project with npm or yarn, the development server fails to start due to a RollupError from the nuxt-simple-sitemap module.

These issues increase the barrier for new contributors to get the project running locally.

Proposed Solution

I have made the following improvements to the README.md:

  1. Added clear instructions for using npm and yarn as alternatives to bun.
  2. Included a new "Troubleshooting" section that explains how to resolve the RollupError by temporarily disabling the nuxt-simple-sitemap module in nuxt.config.ts.

This will provide a smoother setup experience for future contributors. I will be submitting a Pull Request shortly to address this.

ooBean avatar Sep 28 '25 09:09 ooBean

assign me this please

ManojAhire avatar Oct 27 '25 18:10 ManojAhire

Hi @ManojAhire , thanks for your interest! I've already submitted a PR (#2420) to address this issue. Please feel free to review it and leave any feedback you might have!

ooBean avatar Oct 28 '25 01:10 ooBean