docs: split troubleshooting into granular sections #9024
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
🤔 I'm on the fence of whether this deserves its own page. I think it could be moved to its own section in FAQs.mdx. Is there anything else we'd want to have here?
I was tempted to include typed linting .js info, but that's already covered in Typed Linting.
I'm leaning strongly towards this change (moving these two FAQs out) so we can reduce the size of the Troubleshooting portion of the sidebar.
There was a problem hiding this comment.
I think it's worth its own page! See also #8955 (comment)... maybe this is an opportunity to throw in an additional sentence or two that plenty of rules will have no effect on js files, but a few will enforce illegal syntax and must be disabled. And type-aware rules actually can work in js files.
There was a problem hiding this comment.
Yeah! Great. +1. I think that'd be an excellent followup to this (I suspect the discussion over how to phrase the .js recommendations might get long).
docs/troubleshooting/FAQs.mdx
Outdated
| @@ -1,189 +1,166 @@ | |||
| --- | |||
| id: faqs | |||
| title: FAQs | |||
| slug: /troubleshooting/ | |||
| slug: /troubleshooting/faqs | |||
There was a problem hiding this comment.
This is going to break all of our historical links isn't it 😭
Maybe we need error code short URLs to make this easier huehuehue
There was a problem hiding this comment.
It shouldn't with this redirects config! I really hope it doesn't. That'd be a bug if it does.
// in docusaurus.config.mts > redirects
{
from: '/troubleshooting',
to: '/troubleshooting/faqs',
},But yeah strong +1 to error code short URLs.
|
PERSONALLY I don't love having valuable content on a page that's accessible via an expandable header. I think that either: I personally find all the time that I click the arrow and don't find what i'm looking for - only to realise that I actually wanted to click 10px to the left on the item itself. I hate it, personally! I do this all the time on my phone and I hate it. For example I've done this a few times:
Super clunky UX - I hate it. So I'd suggest adding a "General" item beneath FAQs which allows you to see the "general FAQs". |
Following up explicitly: I did this, so that when you click either Troubleshooting & FAQs or FAQs, it takes you to the child General page. 👍 |
ee46c9c to
d1ddbc2
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9024 +/- ##
==========================================
- Coverage 88.17% 88.17% -0.01%
==========================================
Files 415 415
Lines 14363 14362 -1
Branches 4187 4187
==========================================
- Hits 12665 12664 -1
Misses 1381 1381
Partials 317 317
Flags with carried forward coverage won't be shown. Click here to find out more.
|
d1ddbc2 to
585423d
Compare
|
Ugh. I messed up the Git merges. Will fix this in a bit. Edit: done, I think. |
585423d to
bafe6c8
Compare
052c190 to
03275e9
Compare
|
I'm going to merge this now, because it's been sitting for a while and the merge conflicts keep getting more painful 😅. I think as a followup we'll want to do two things:
|
635133a
into
typescript-eslint:main
PR Checklist
Overview
sidebar.base.jscontents so the sidebar isn't now bigger than before💖