Skip to content

Overviews & copy tweaks in user documentation pages #16473

@bpmutter

Description

@bpmutter

ESLint version

v8.x

What problem do you want to solve?

When looking at the usr documentation of ESLint, it can be unclear what the page is about at the start of the page, and why users should care about that page's content.

There are also small copy changes to be fixed throughout these pages.

What do you think is the correct solution?

  • Review all pages in the user documentation section and add overviews at the top of pages explaining what the page covers and why you might use it.
  • For example, on Plugins at the beginning of the page, include an overview of what plugins are.
  • Apply small copy edits throughout these pages.

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