docs: fix broken link in getting started page details section #8463
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Corrects a broken link in the recommended configurations. Previously pointing to localhost, the link has been updated to the correct public host
|
Thanks for the PR, @salitha-pathi! 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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8463 +/- ##
==========================================
- Coverage 87.74% 86.94% -0.81%
==========================================
Files 398 252 -146
Lines 13827 12251 -1576
Branches 4067 3861 -206
==========================================
- Hits 12133 10652 -1481
+ Misses 1397 1332 -65
+ Partials 297 267 -30
Flags with carried forward coverage won't be shown. Click here to find out more. |
bradzacher
approved these changes
Feb 14, 2024
3 tasks
auvred
requested changes
Feb 14, 2024
docs/Getting_Started.mdx
Outdated
| @@ -72,7 +72,7 @@ The [`config`](./packages/TypeScript_ESLint.mdx) helper sets three parts of ESLi | ||
|
|
||
| - [Parser](https://eslint.org/docs/latest/use/configure/parser): set to [`@typescript-eslint/parser`](./packages/Parser.mdx) so ESLint knows how to parse the new pieces of TypeScript syntax. | ||
| - [Plugins](https://eslint.org/docs/latest/use/configure/plugins): set to [`@typescript-eslint/eslint-plugin`](./packages/ESLint_Plugin.mdx) to load [rules listed in our _Rules_ page](./Rules). | ||
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](http://localhost:3000/linting/configs#recommended) to enable our most commonly useful lint rules. | ||
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](https://typescript-eslint.io/linting/configs/#recommended) to enable our most commonly useful lint rules. |
There was a problem hiding this comment.
Suggested change
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](https://typescript-eslint.io/linting/configs/#recommended) to enable our most commonly useful lint rules. | |
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](./linting/configs/#recommended) to enable our most commonly useful lint rules. |
Let's update it to a relative path? This is a more flexible solution than a hard-coded URL. It will work correctly regardless of the domain name! For example, in Netlify Preview Deployments (preview deployment for this PR). What do you think?
bradzacher
requested changes
Feb 14, 2024
docs/Getting_Started.mdx
Outdated
| @@ -72,7 +72,7 @@ The [`config`](./packages/TypeScript_ESLint.mdx) helper sets three parts of ESLi | ||
|
|
||
| - [Parser](https://eslint.org/docs/latest/use/configure/parser): set to [`@typescript-eslint/parser`](./packages/Parser.mdx) so ESLint knows how to parse the new pieces of TypeScript syntax. | ||
| - [Plugins](https://eslint.org/docs/latest/use/configure/plugins): set to [`@typescript-eslint/eslint-plugin`](./packages/ESLint_Plugin.mdx) to load [rules listed in our _Rules_ page](./Rules). | ||
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](http://localhost:3000/linting/configs#recommended) to enable our most commonly useful lint rules. | ||
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](https://typescript-eslint.io/linting/configs/#recommended) to enable our most commonly useful lint rules. |
There was a problem hiding this comment.
Suggested change
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](https://typescript-eslint.io/linting/configs/#recommended) to enable our most commonly useful lint rules. | |
| - [Rules](https://eslint.org/docs/latest/use/configure/rules): extends from our [recommended configuration](./linting/configs/#recommended) to enable our most commonly useful lint rules. |
Can you please use a relative link instead?
bradzacher
approved these changes
Feb 14, 2024
2 tasks
yeonjuan
pushed a commit
to yeonjuan/typescript-eslint
that referenced
this pull request
Feb 18, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Overview
Hey! 👋
I noticed a broken link in the "Getting Started" page, specifically in the "Details" section under the recommended configurations link. It was pointing to localhost instead of the correct public domain.
I've updated the link to direct users to the correct destination.
As far as I can tell, there are no open issues related to this, and it's likely that no one has noticed the broken link yet.
This PR resolves the issue and ensures a smoother experience for users navigating the documentation.
Thanks for reviewing! 🚀