Files
becc9be0e5 docs: improve clarity, grammar, and wording in documentation site README (#20370)
* Improve documentation clarity, grammar, and wording in docs README

This update refines the ESLint documentation README by improving clarity, fixing punctuation issues, and making the instructions easier to follow.
Key enhancements include:
	•	Reworded installation and local development steps for clearer instructions
	•	Replaced vague phrases with explicit and concise alternatives
	•	Standardized wording in the “Scripts” section
	•	Corrected grammar issues, including improper comma usage
	•	Improved the license line for proper punctuation and readability

No functional or code changes were made—this commit focuses solely on documentation quality and consistency.

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

* Update docs/README.md

Co-authored-by: Milos Djermanovic <[email protected]>

---------

Co-authored-by: Milos Djermanovic <[email protected]>
2025-12-04 15:48:50 +01:00

1.1 KiB
Raw Permalink Blame History

ESLint Documentation

Install Dependencies

Install all required dependencies for the documentation site by running the following command inside the docs folder:

npm install

Run Locally

To start the documentation site locally, run the following command inside the docs folder:

npm start

After the build completes, the documentation site will be available at http://localhost:2023.

Scripts

To update the links data file, run the following command from the project root (not the docs folder):

npm run build:docs:update-links

To lint the documentation’s JavaScript files, run the following command from the project root (not the docs folder):

npm run lint:docs:js

To auto-fix JavaScript files, run the following command from the project root (not the docs folder):

npm run lint:fix:docs:js

License

© OpenJS Foundation and ESLint contributors, www.openjsf.org. Content licensed under the MIT License.