Skip to content

Documentation error: Node.js version prerequisite not properly mentioned #1006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Khizarshah01 opened this issue Jun 1, 2025 · 0 comments
Open

Documentation error: Node.js version prerequisite not properly mentioned #1006

Khizarshah01 opened this issue Jun 1, 2025 · 0 comments

Comments

@Khizarshah01
Copy link
Contributor

The main README specifies Node.js v16.19.0 as the required version for local development:

Node.js: Version 16.19.0 is required. Use Node Version Manager (NVM) for easy switching.

However, when running the docs website inside the docs folder, the following error appears if Node.js version is below 18:

[ERROR] Minimum Node.js version not met :(
[INFO] You are using Node.js v16.19.0, Requirement: Node.js >=18.0.

This inconsistency can confuse developers trying to set up the environment.

Suggested fixes:

  • Clarify in the docs README that the docs folder requires Node.js 18 or higher.
  • Alternatively, update dependencies to align Node.js version requirements across the repository.

Improving this will enhance the onboarding experience and reduce setup errors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Khizarshah01