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.

Sign up for GitHub

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

Jump to bottom

Docs: Add pages for the contents of configurations to the website? #5002

Closed
2 tasks done
JoshuaKGoldberg opened this issue May 17, 2022 · 1 comment · Fixed by #5719
Closed
2 tasks done

Docs: Add pages for the contents of configurations to the website? #5002

JoshuaKGoldberg opened this issue May 17, 2022 · 1 comment · Fixed by #5719
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented May 17, 2022 •
edited

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

#4648 (comment) brings up a good point: we never explicitly say what the contents of recommended, recommended-requiring-type-checking, or strict are. Users can piece this together from info on https://typescript-eslint.io/docs/linting/rules, but that's laborious.

How about we add pages like https://typescript-eslint.io/docs/linting/configs/recommended that include each rule in that config and their default options?

Affected URL(s)

https://typescript-eslint.io/docs/linting/configs
https://typescript-eslint.io/docs/linting/configs/*
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels May 17, 2022
@Josh-Cena
Copy link
Member

If there's #4168 this would be largely unnecessary, but... 😄

@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels May 17, 2022
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 3, 2022
Merged
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(website): add details to Configurations page JoshuaKGoldberg/typescript-eslint
3 participants
@JoshuaKGoldberg @bradzacher @Josh-Cena