Skip to content

Commit 635133a

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
docs: split troubleshooting into granular sections (typescript-eslint#9024)
* docs: split troubleshooting into granular sections * Merged frameworks back into FAQs, and moved Formatting and TSLint inside it * Set up redirects and corrected some slugs * A couple more redirects * A redirect for monorepos * Sidebar naming: Troubleshooting > Type Information * Clarified Monorepos troubleshooting re projectService * Pagination and sidebar fixing * Reorganize the what-abouts to Users * Fixed failing links blocking build * fix lint complaints * fix lint complaints (again) * Re-apply changes: Troubleshooting & FAQs starting on General * Fix build links * Fix links post-merge * Move a general FAQ to General * Save a file * Re-apply: Netlify * A few reverts * Slightly more reverting * Slightly more reverting * fix: unit tests * More test fixes
1 parent cc11eae commit 635133a

34 files changed

+738
-616
lines changed

‎.github/replies.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,5 @@ replies:
8888
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).
8989
\
9090
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).
91-
See also our [What About Formatting?](https://typescript-eslint.io/linting/troubleshooting/formatting) docs.
91+
See also our [What About Formatting?](https://typescript-eslint.io/users/what-about-formatting) docs.
9292
name: Use Prettier

‎docs/getting-started/Legacy_ESLint_Setup.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ ESLint will lint all TypeScript compatible files within the current folder, and
8484

8585
## Next Steps
8686

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

8989
### Additional Configs
9090

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

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

121121
### Documentation Resources
122122

‎docs/getting-started/Quickstart.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ ESLint will lint all TypeScript compatible files within the current folder, and
8383

8484
## Next Steps
8585

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

8888
### Additional Configs
8989

‎docs/getting-started/Typed_Linting.mdx

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
id: typed-linting
33
title: Linting with Type Information
4-
pagination_next: getting-started/typed-linting/monorepos
54
---
65

76
import Tabs from '@theme/Tabs';
@@ -85,7 +84,7 @@ In more detail:
8584

8685
:::caution
8786
Your ESLint config file may start receiving a parsing error about type information.
88-
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).
87+
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).
8988
:::
9089

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

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

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

267266
## Troubleshooting
268267

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

‎docs/maintenance/Issues.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ We avoid features that:
141141
- Are only relevant for a minority of users, as they aren't likely worth the maintenance burden
142142
- Aren't TypeScript-specific (e.g. should be in ESLint core instead)
143143
- Are only relevant with specific userland frameworks or libraries, such as Jest or React
144-
- Are for "formatting" functionality (we [strongly recommend users use a separate dedicated formatter](../troubleshooting/Formatting.mdx))
144+
- Are for "formatting" functionality (we [strongly recommend users use a separate dedicated formatter](../users/What_About_Formatting.mdx))
145145

146146
#### ✨ Rule Enhancements
147147

‎docs/packages/ESLint_Plugin_TSLint.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: eslint-plugin-tslint
1010
> ESLint plugin that allows running TSLint rules within ESLint to help you migrate from TSLint to ESLint. ✨
1111
1212
:::caution
13-
Per [What About TSLint?](../troubleshooting/TSLint.mdx), we highly recommend migrating off TSLint.
13+
Per [What About TSLint?](../users/What_About_TSLint.mdx), we highly recommend migrating off TSLint.
1414
See [Getting Started](../getting-started/Quickstart.mdx) for documentation on how to lint your TypeScript code with ESLint.
1515
:::
1616

0 commit comments

Comments
 (0)