Skip to content

Commit 2307a17

Browse files
Josh Goldbergbradzacher
Josh Goldberg
andauthored
docs: audit and revamp of main pages (#4112)
* docs: audit and revamp of main pages * chore: add astexplorer, markdownlint to .cspell.json * Apply suggestions from code review Co-authored-by: Brad Zacher <[email protected]> * chore: suggestions from code review Co-authored-by: Brad Zacher <[email protected]>
1 parent d97140e commit 2307a17

21 files changed

+353
-461
lines changed

.cspell.json

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
"Airbnb's",
4343
"ambiently",
4444
"ASTs",
45+
"astexplorer",
4546
"autofix",
4647
"autofixers",
4748
"autofixes",
@@ -68,6 +69,7 @@
6869
"IIFE",
6970
"IIFEs",
7071
"linebreaks",
72+
"markdownlint",
7173
"necroing",
7274
"nocheck",
7375
"nullish",

.github/ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The more relevant information you can include, the faster we can find the issue
1515

1616
- [ ] I have tried restarting my IDE and the issue persists.
1717
- [ ] I have updated to the latest version of the packages.
18-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
18+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
1919

2020
**Repro**
2121

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ contact_links:
33
-
44
name: FAQ
55
about: Please check out our FAQ before filing new issues
6-
url: https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
6+
url: https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md
77
-
88
name: Getting Started Guide
99
about: If you're looking for help setting up check out our getting started guide

.github/ISSUE_TEMPLATE/eslint-plugin-tslint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you have a problem with a specific lint rule, please back out and select the
2323

2424
- [ ] I have tried restarting my IDE and the issue persists.
2525
- [ ] I have updated to the latest version of the packages.
26-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
26+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
2727

2828
**Repro**
2929

.github/ISSUE_TEMPLATE/eslint-plugin-typescript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Are you opening an issue because the rule you're trying to use is not found?
2828

2929
- [ ] I have tried restarting my IDE and the issue persists.
3030
- [ ] I have updated to the latest version of the packages.
31-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
31+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
3232

3333
**Repro**
3434

.github/ISSUE_TEMPLATE/typescript-eslint-parser.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you have a problem with a specific lint rule, please back out and select the
2424

2525
- [ ] I have tried restarting my IDE and the issue persists.
2626
- [ ] I have updated to the latest version of the packages.
27-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
27+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
2828

2929
**Repro**
3030

.github/ISSUE_TEMPLATE/typescript-eslint-scope-manager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you have a problem with the parser, please back out and select the `@typescri
2424

2525
- [ ] I have tried restarting my IDE and the issue persists.
2626
- [ ] I have updated to the latest version of the packages.
27-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
27+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
2828

2929
**Repro**
3030

.github/ISSUE_TEMPLATE/typescript-eslint-utils.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you have a problem with the parser, please back out and select the `@typescri
2424

2525
- [ ] I have tried restarting my IDE and the issue persists.
2626
- [ ] I have updated to the latest version of the packages.
27-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
27+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
2828

2929
**Repro**
3030

.github/ISSUE_TEMPLATE/typescript-estree.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you have a problem with a specific lint rule, please back out and select the
2323

2424
- [ ] I have tried restarting my IDE and the issue persists.
2525
- [ ] I have updated to the latest version of the packages.
26-
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
26+
- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TROUBLESHOOTING.md) and my problem is not listed.
2727

2828
**Repro**
2929

0 commit comments

Comments
 (0)