Phase 4: “Extend ESLint” documentation update outline

eslint-docs-update-phase4-outline.md

author	date
bpmutter	2022/12/21

Overview

This document outlines the changes for Phase 4: “Extend ESLint” of the Documentation Update Project.

Tasks

Ways to Extend ESLint page

New page with overview of various ways to extend ESLint.

Sections:

• Plugins
• Custom Rules
• Custom Parsers
• Custom Formatters
• Shareable Configurations

Overviews & Copy Edits on All Main Pages

On each of the following pages:

• Plugins
• Custom Rules
• Custom Formatters
• Custom Parsers
• Shareable Configurations

Create separate PRs to:

• add overview to page
  • At the top of pages explaining what an extension type is, and why you might want to use it.
    • For example, in the custom formatters documentation, explain why someone might want to create a custom formatter.
• copy edit

(Potentially) Create Separate Guided Tutorial Pages for All the Extension Types

I don't know if this is something we want to commit to maintaining. (Maybe it is though!) Worth discussion with core team.

• Guided tutorials for creating extensions
• Create a couple of “getting started” type tutorials for creating the most common extension types.
  • For example, a tutorial on making a plugin
  • These tutorials can provide opinionated guidance and promote best practices.

Investigate JSDoc for Node.js API

Probably won't be able to do full JSDoc-ing as part of this phase given the scope of that. But I would like to fully understand the feasibility of getting this done, and how it'd work with the rest of the ESLint documentation site.

tool like this could work - https://github.com/jsdoc2md/jsdoc-to-markdown/wiki and here's an example of doing one docs file per class - https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class might even be able to get full JSDoc-ing

Open Questions

TBD

Notable Not Doing

Tbd