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: Separate FAQs into discrete sections #8926

Open
2 tasks done
JoshuaKGoldberg opened this issue Apr 15, 2024 · 0 comments · May be fixed by #9024
Open
2 tasks done

Docs: Separate FAQs into discrete sections #8926

JoshuaKGoldberg opened this issue Apr 15, 2024 · 0 comments · May be fixed by #9024
Assignees
@JoshuaKGoldberg
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

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

Suggested Changes

Our Troubleshooting & FAQs page at https://typescript-eslint.io/troubleshooting/ has grown to quite a few FAQs. I'm personally finding it hard to read through. We've also had a few questions on the Discord & issue tracker lately that have been pretty directly answered by those FAQs. That leads me to think they've gotten to the point of unwieldiness where users aren't feeling confident reading & searching through them.

Proposal: let's delineate them into sections? Like, "Typed Linting Setup", "Working with JavaScript", "Performance Troubleshooting" (which is already split out!), etc.?

Affected URL(s)

https://typescript-eslint.io/troubleshooting/
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Apr 15, 2024
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Apr 15, 2024
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Apr 28, 2024
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Apr 28, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title Docs: Consider separating FAQs into discrete sections Docs: Separate FAQs into discrete sections Apr 28, 2024
This was referenced Apr 28, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: split troubleshooting into granular sections JoshuaKGoldberg/typescript-eslint
1 participant
@JoshuaKGoldberg