Skip to content

Docs: Getting Started Clean up & Expansion #16508

@bpmutter

Description

@bpmutter

ESLint version

v8.x

What problem do you want to solve?

clarify and expand the documentation user guide's Getting Started page.

What do you think is the correct solution?

  • Refactor introduction of page to be more about the value proposition of ESLint, rather than comparison to JSLint/JSHint.
  • Cosmetic updates throughout the page
  • Add new section ‘Manual Set up’ with the following procedure:
    • npm i -D eslint
    • Add .eslint[.js | json | .yaml | ] file
    • Add custom configurations
      • Things like rules, environment, plugins, etc.
      • Link to pages in the Configuration section where these are discussed more.
    • Run linting. Mention two ways:
      • Running from CLI.
      • Also Incorporate into package.json

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    acceptedThere is consensus among the team that this change meets the criteria for inclusionarchived due to ageThis issue has been archived; please open a new issue for any further discussiondocumentationRelates to ESLint's documentationenhancementThis change enhances an existing feature of ESLint

    Type

    No type

    Projects

    Status

    Complete

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions