Skip to content

docs: improve readability by fixing grammar and formatting code blocks#8710

Merged
avivkeller merged 2 commits intonodejs:mainfrom
Venkat-Entropik:docs/improve-documentation-readability
Mar 12, 2026
Merged

docs: improve readability by fixing grammar and formatting code blocks#8710
avivkeller merged 2 commits intonodejs:mainfrom
Venkat-Entropik:docs/improve-documentation-readability

Conversation

@Venkat-Entropik
Copy link
Contributor

Description

This PR improves documentation readability by correcting grammar, refining wording, and formatting command examples in code blocks.

Some sentences were simplified to make the documentation clearer and more consistent.

Examples of improvements:

Before:
"Nodejs.org by the OpenJS Foundation is the official website..."

After:
"Nodejs.org, maintained by the OpenJS Foundation, is the official website..."

Before:
"Any person who wants to contribute to the Website is welcome!"

After:
"Anyone who wants to contribute to the website is welcome."

Additionally, command examples are now properly formatted inside code blocks:

pnpm install --frozen-lockfile
pnpm dev

These updates improve readability and maintain consistency across the documentation.


Validation

  • Verified that the documentation renders correctly with the updated wording.
  • Confirmed that command examples display properly inside code blocks.
  • Ran the following commands locally to ensure the project builds correctly:
pnpm install
pnpm format
pnpm test
pnpm build

Related Issues

Fixes #8704


Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm format to ensure the code follows the style guide.
  • I have run pnpm test to check if all tests are passing.
  • I have run pnpm build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

@Venkat-Entropik Venkat-Entropik requested a review from a team as a code owner March 10, 2026 04:14
@vercel
Copy link

vercel bot commented Mar 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nodejs-org Ready Ready Preview Mar 10, 2026 0:42am

Request Review

@github-actions
Copy link
Contributor

👋 Codeowner Review Request

The following codeowners have been identified for the changed files:

Team reviewers: @nodejs/nodejs-website

Please review the changes when you have a chance. Thank you! 🙏

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.12%. Comparing base (abe2187) to head (85a31a7).
⚠️ Report is 5 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8710      +/-   ##
==========================================
+ Coverage   75.10%   75.12%   +0.02%     
==========================================
  Files         104      104              
  Lines        9162     9167       +5     
  Branches      315      315              
==========================================
+ Hits         6881     6887       +6     
+ Misses       2279     2278       -1     
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@avivkeller avivkeller added this pull request to the merge queue Mar 12, 2026
Merged via the queue into nodejs:main with commit c9fa123 Mar 12, 2026
12 checks passed
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.

Grammar and formatting issues in README documentation

3 participants