-
-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Open
eslint/rewrite
#328Labels
documentationRelates to ESLint's documentationRelates to ESLint's documentation
Description
Docs page(s)
https://github.com/eslint/rewrite
- https://github.com/eslint/rewrite/blob/main/packages/compat/README.md
- https://github.com/eslint/rewrite/blob/main/packages/config-array/README.md
- https://github.com/eslint/rewrite/blob/main/packages/config-helpers/README.md
- https://github.com/eslint/rewrite/blob/main/packages/core/README.md
- https://github.com/eslint/rewrite/blob/main/packages/mcp/README.md
- https://github.com/eslint/rewrite/blob/main/packages/migrate-config/README.md
- https://github.com/eslint/rewrite/blob/main/packages/object-schema/README.md
- https://github.com/eslint/rewrite/blob/main/packages/plugin-kit/README.md
https://github.com/eslint/json/blob/main/README.md
- https://github.com/eslint/js/blob/main/packages/espree/README.md
- https://github.com/eslint/js/blob/main/packages/eslint-scope/README.md
https://github.com/eslint/json/blob/main/README.md
https://github.com/eslint/css/blob/main/README.md
https://github.com/eslint/csstree/blob/main/README.md
https://github.com/eslint/markdown/blob/main/README.md
https://github.com/eslint/config-inspector/blob/main/README.md
What documentation issue do you want to solve?
For now, few packages like https://github.com/eslint/eslint/, https://github.com/eslint/generator-eslint, etc have their node prerequisites mentioned in their README.md, but majority of the repos don't have.
What do you think is the correct solution?
Few solutions which I can think of:
- Update the README.md in all the repos to follow a similar pattern where each will have a prerequisite section for node.
- Standardise the node prerequisite just like being done for Sponsors section, which will allow us to do the change in 1 repo and fetch it in all README.md but the catch which I see here is this would mean to add a dedicated required node version section, not prerequiste section
Participation
- I am willing to submit a pull request for this change.
Additional comments
No response
Metadata
Metadata
Assignees
Labels
documentationRelates to ESLint's documentationRelates to ESLint's documentation
Type
Projects
Status
Evaluating