Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
491db65
docs: split troubleshooting into granular sections
JoshuaKGoldberg Apr 28, 2024
f80de6d
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg May 9, 2024
5ec0f6a
Merged frameworks back into FAQs, and moved Formatting and TSLint ins…
JoshuaKGoldberg May 9, 2024
9cefeaa
Set up redirects and corrected some slugs
JoshuaKGoldberg May 9, 2024
0fde783
A couple more redirects
JoshuaKGoldberg May 9, 2024
7a4bee0
A redirect for monorepos
JoshuaKGoldberg May 9, 2024
6e0a4bf
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg May 11, 2024
abcd1a5
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg May 27, 2024
397b057
Sidebar naming: Troubleshooting > Type Information
JoshuaKGoldberg May 28, 2024
13b4640
Clarified Monorepos troubleshooting re projectService
JoshuaKGoldberg May 28, 2024
600da95
Pagination and sidebar fixing
JoshuaKGoldberg May 31, 2024
eebba86
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg May 31, 2024
3e27849
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg Jun 2, 2024
4f66857
Reorganize the what-abouts to Users
JoshuaKGoldberg Jun 2, 2024
752dece
Fixed failing links blocking build
JoshuaKGoldberg Jun 2, 2024
9c8835a
Merge branch 'main' into docs-troubleshooting-sections
JoshuaKGoldberg Jun 3, 2024
dfd19d8
fix lint complaints
JoshuaKGoldberg Jun 3, 2024
bafe6c8
fix lint complaints (again)
JoshuaKGoldberg Jun 3, 2024
0303c24
Re-apply changes: Troubleshooting & FAQs starting on General
JoshuaKGoldberg Jun 24, 2024
e6ac7ae
Fix build links
JoshuaKGoldberg Jun 24, 2024
445600a
Merge branch 'main'
JoshuaKGoldberg Jun 24, 2024
85c53ee
Fix links post-merge
JoshuaKGoldberg Jun 24, 2024
6be7d54
Move a general FAQ to General
JoshuaKGoldberg Jun 24, 2024
991c34a
Save a file
JoshuaKGoldberg Jun 24, 2024
03275e9
Re-apply: Netlify
JoshuaKGoldberg Jun 24, 2024
a50c1e4
A few reverts
JoshuaKGoldberg Jun 24, 2024
4dd6537
Slightly more reverting
JoshuaKGoldberg Jun 24, 2024
4689bc1
Slightly more reverting
JoshuaKGoldberg Jun 24, 2024
7b68c1b
fix: unit tests
JoshuaKGoldberg Jun 24, 2024
33cf02a
More test fixes
JoshuaKGoldberg Jun 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/replies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,5 @@ replies:
The configurability also leads to huge fanout [making tests huge, and awful to maintain](https://github.com/typescript-eslint/typescript-eslint/blob/b814e635c1f34139c89e0176727480935dd45cac/packages/eslint-plugin/tests/rules/type-annotation-spacing.test.ts).
\
It's for these reasons that [eslint has frozen all stylistic lint rule options, and will not accept any new ones](https://eslint.org/blog/2020/05/changes-to-rules-policies).
See also our [What About Formatting?](https://typescript-eslint.io/linting/troubleshooting/formatting) docs.
See also our [What About Formatting?](https://typescript-eslint.io/users/what-about-formatting) docs.
name: Use Prettier
4 changes: 2 additions & 2 deletions docs/getting-started/Legacy_ESLint_Setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ ESLint will lint all TypeScript compatible files within the current folder, and

## Next Steps

If you're having problems getting this working, please have a look at our [Troubleshooting & FAQs](../troubleshooting/FAQ.mdx).
If you're having problems getting this working, please have a look at our [Troubleshooting & FAQs](../troubleshooting/faqs/General.mdx).

### Additional Configs

Expand Down Expand Up @@ -116,7 +116,7 @@ You can read more about these in our [shared configurations docs](../users/Share
### Typed Linting

We also provide a plethora of powerful rules that utilize the power of TypeScript's type information.
[Visit the next page for a typed rules setup guide](./Typed_Linting.mdx).
[Visit the next page for a typed rules setup guide](../troubleshooting/typed-linting/index.mdx).

### Documentation Resources

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/Quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ ESLint will lint all TypeScript compatible files within the current folder, and

## Next Steps

If you're having problems getting this working, please have a look at our [Troubleshooting & FAQs](../troubleshooting/FAQ.mdx).
If you're having problems getting this working, please have a look at our [Troubleshooting & FAQs](../troubleshooting/faqs/General.mdx).

### Additional Configs

Expand Down
7 changes: 3 additions & 4 deletions docs/getting-started/Typed_Linting.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: typed-linting
title: Linting with Type Information
pagination_next: getting-started/typed-linting/monorepos
---

import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -85,7 +84,7 @@ In more detail:

:::caution
Your ESLint config file may start receiving a parsing error about type information.
See [our TSConfig inclusion FAQ](../troubleshooting/FAQ.mdx#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file).
See [our TSConfig inclusion FAQ](../troubleshooting/faqs/General.mdx#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file).
:::

With that done, run the same lint command you ran before.
Expand Down Expand Up @@ -186,7 +185,7 @@ module.exports = {
See [the `@typescript-eslint/parser` docs for more details](../packages/Parser.mdx#project).

:::note
If your project is a multi-package monorepo, see [our docs on configuring a monorepo](./typed-linting/Monorepos.mdx).
If your project is a multi-package monorepo, see [our docs on configuring a monorepo](../troubleshooting/typed-linting/Monorepos.mdx).
:::

### How can I disable type-aware linting for a subset of files?
Expand Down Expand Up @@ -266,4 +265,4 @@ This means that generally they usually only run a complete lint before a push, o

## Troubleshooting

If you're having problems getting this working, please have a look at our [Troubleshooting and FAQs page](../troubleshooting/FAQ.mdx).
If you're having problems getting this working, please have a look at our [Troubleshooting FAQs](../troubleshooting/faqs/General.mdx).
2 changes: 1 addition & 1 deletion docs/maintenance/Issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ We avoid features that:
- Are only relevant for a minority of users, as they aren't likely worth the maintenance burden
- Aren't TypeScript-specific (e.g. should be in ESLint core instead)
- Are only relevant with specific userland frameworks or libraries, such as Jest or React
- Are for "formatting" functionality (we [strongly recommend users use a separate dedicated formatter](../troubleshooting/Formatting.mdx))
- Are for "formatting" functionality (we [strongly recommend users use a separate dedicated formatter](../users/What_About_Formatting.mdx))

#### ✨ Rule Enhancements

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/ESLint_Plugin_TSLint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_label: eslint-plugin-tslint
> ESLint plugin that allows running TSLint rules within ESLint to help you migrate from TSLint to ESLint. ✨

:::caution
Per [What About TSLint?](../troubleshooting/TSLint.mdx), we highly recommend migrating off TSLint.
Per [What About TSLint?](../users/What_About_TSLint.mdx), we highly recommend migrating off TSLint.
See [Getting Started](../getting-started/Quickstart.mdx) for documentation on how to lint your TypeScript code with ESLint.
:::

Expand Down
Loading
Loading