Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Reorganize Configuration Documentation #13837

Merged
merged 96 commits into from Jan 23, 2021

Conversation

@khawarlatifkhan
Copy link
Contributor

@khawarlatifkhan khawarlatifkhan commented Nov 12, 2020

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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

  • Reorganized the ESLint configuration documentation by dividing the single document into 5 sections (viz. Configuration Files, Language Options, Rules, Plugins, and Ignoring Code).
  • Created an index (README.md) file for the "Configuring ESLint" directory, to improve the structure of the documentation.
  • Updated and added new links to the .md files where necessary.

Is there anything you'd like reviewers to focus on?

At the beginning of all 5 sections, a brief introduction/context is needed so that the readers get a little idea of what they're going to gain from this section. Some feedback on that will be of great help.

…ocs/user-guide/configuring-ESLint/configuration-files.md
…er-guide/configuring-ESLint/ignoring-code.md
…/user-guide/configuring-ESLint/language-options.md
vzvu3k6k added a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 7, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
vzvu3k6k added a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 7, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
ljharb added a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 9, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jul 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants