docs: improve clarity, grammar, and wording in documentation site README #20370
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hi @Lumowhisp!, thanks for the Pull Request The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.
To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page. Read more about contributing to ESLint here |
mdjermanovic
reviewed
Dec 4, 2025
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
I updated the documentation README to improve clarity, fix punctuation issues, and ensure consistent wording across sections. All changes are limited to documentation only, with no modifications to ESLint’s codebase.
Is there anything you'd like reviewers to focus on?
Please verify that the updated wording aligns with ESLint’s documentation style and maintains the original intent of the instructions.