Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
docs: split troubleshooting into granular sections#9024
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
docs: split troubleshooting into granular sections#9024
Uh oh!
There was an error while loading.Please reload this page.
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 onhttps://opencollective.com/typescript-eslint. |
netlifybot commentedApr 28, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site configuration. |
nx-cloudbot commentedApr 28, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
JoshuaKGoldbergApr 28, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
🤔 I'm on the fence of whether this deserves its own page. I think it could be moved to its own section inFAQs.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 inTyped Linting.
I'm leaning strongly towards this change (moving these two FAQs out) so we can reduce the size of theTroubleshooting portion of the sidebar.
kirkwaiblingerMay 11, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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 actuallycan work in js files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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
JoshuaKGoldbergMay 28, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
bradzacher commentedJun 4, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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 eitherTroubleshooting & FAQs orFAQs, it takes you to the childGeneral page. 👍 |
ee46c9c
tod1ddbc2
Comparecodecovbot commentedJun 22, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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
to585423d
CompareJoshuaKGoldberg commentedJun 22, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Ugh. I messed up the Git merges. Will fix this in a bit. Edit: done, I think. |
585423d
tobafe6c8
Compare052c190
to03275e9
CompareI'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
intotypescript-eslint:mainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
PR Checklist
Overview
sidebar.base.js
contents so the sidebar isn't now bigger than before💖