docs: improve readability by fixing grammar and formatting code blocks#8710
docs: improve readability by fixing grammar and formatting code blocks#8710Venkat-Entropik wants to merge 2 commits intonodejs:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
👋 Codeowner Review RequestThe 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! 🙏 |
| pnpm dev | ||
|
|
||
| # listening at localhost:3000 | ||
| # Listening at http://localhost:3000 |
There was a problem hiding this comment.
What's wrong with the previous comment?
There was a problem hiding this comment.
Thanks for pointing that out.
I updated the comment to improve consistency and clarity by capitalizing the sentence and explicitly including the http:// protocol.
However, the original comment also works fine. I'm happy to revert the change if you prefer keeping the previous wording.
README.md
Outdated
| This project adopts the Node.js [Code of Conduct][]. | ||
|
|
||
| Any person who wants to contribute to the Website is welcome! Please read [Contribution Guidelines][] and see the [Figma Design][] to understand better the structure of this repository. | ||
| Anyone who wants to contribute to the website is welcome. Please read [Contribution Guidelines][] and see the [Figma Design][] to understand better the structure of this repository. |
There was a problem hiding this comment.
| Anyone who wants to contribute to the website is welcome. Please read [Contribution Guidelines][] and see the [Figma Design][] to understand better the structure of this repository. | |
| Anyone who wants to contribute to the website is welcome! Please read [Contribution Guidelines][] and see the [Figma Design][] to understand better the structure of this repository. |
There was a problem hiding this comment.
Thanks for the suggestion! I've updated the sentence to keep the exclamation mark.
3 participants
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:
These updates improve readability and maintain consistency across the documentation.
Validation
pnpm install pnpm format pnpm test pnpm buildRelated Issues
Fixes #8704
Check List
pnpm formatto ensure the code follows the style guide.pnpm testto check if all tests are passing.pnpm buildto check if the website builds without errors.