Docs: Add a Glossary page

[JoshuaKGoldberg]

Docs page(s)

https://eslint.org/docs/latest/glossary

What documentation issue do you want to solve?

There are a lot of terms around linting / ESLint that many users have trouble with:

• The difference between rule "fixes" and "suggestions" (Suggestion: Explicit docs page for rule fixes and suggestions eslint.org#479)
• The specific terms used to describe types of rules: "formatting", "logical", and "style" (Suggestion: Be more clear in differentiating "formatting" vs "style" eslint.org#419)
• Terms relevant to linting or popular lint rules that many developers have trouble with: "callback", "expression", "executor", "identifier", "scope", etc.
• Terms specific to linting (or contexts for existing terms): "formatter", "override", "node", "parser", "plugin", "report", "rule", "violation", ...really everything in the AST - and AST itself.

Many of those terms are explained within https://eslint.org/docs/latest/use right now, and especially within https://eslint.org/docs/latest/use/core-concepts. But those docs are written in long-form and meant to be consumed as a large entity. It's hard to find answers to a single "what does '...' mean?" question within them.

What do you think is the correct solution?

I'd love a dedicated Glossary page in the site that succinctly describes what each of these terms mean & links to the docs that introduce each of them. That way, if someone asks what a term means, we can give them a more precise answer than a general docs page.

Participation

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

Additional comments

Other examples in the wild of "glossary" vs "use" splits in docs:

• https://codecademy.com/docs is an example of a general-purpose coding glossary
• https://react.dev has a split between "learn" and "reference"

[nzakas]

Sounds like a good idea to me. I'm sure this will uncover inconsistencies with how we refer to things in the docs, and that's a good thing.

[nzakas]

@JoshuaKGoldberg do you intend to work on this?

[JoshuaKGoldberg]

Hi, yes! Sorry for the delay - will clean & push up what I have this week.

[nzakas]

Sounds good. 👍