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.

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

docs: split troubleshooting into granular sections #9024

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Apr 28, 2024

PR Checklist

Overview

  • Move around the FAQs into a few new sections
  • Move around sidebar.base.js contents so the sidebar isn't now bigger than before
  • Add notes on followup issues we can file to fill out those new FAQs (💡!)
  • Add redirects so old user-facing code links included in code still work
Before After
'Before' screenshot showing the current menu with slightly more vertical height 'After' screenshot showing the updated menu with slightly less vertical height

@typescript-eslint
Copy link
Contributor

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.

Copy link

netlify bot commented Apr 28, 2024

Deploy Preview for typescript-eslint failed.

Name Link
🔨 Latest commit 6e0a4bf
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/663f84abecd2d90008720a60

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Josh-Cena do you have any advice on a good/right way to set up hash redirects? I'm not confident that a Netlify redirect is the right one. Or whether they even support # hashes.

Copy link
Member Author

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 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.

Copy link
Member

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 actually can work in js files.

Copy link
Member Author

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).

@JoshuaKGoldberg JoshuaKGoldberg requested review from rubiesonthesky and Josh-Cena and removed request for rubiesonthesky May 9, 2024 15:28
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review May 9, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Separate FAQs into discrete sections
3 participants