Skip to content

docs: Improve Local Setup Guide for New Contributors #2419

@ooBean

Description

@ooBean

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions