docs: document disabling VS Code TS plugin #605
Merged
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
IgnaceMaes
commented
Jul 31, 2023
| @@ -10,7 +10,16 @@ See the [Glint home page] for a more detailed Getting Started guide. | |||
|
|
|||
| 1. Add `@glint/core`, `@glint/template` and an appropriate environment package to your project's `devDependencies`. | |||
| 1. Add a `"glint"` key to your project's `tsconfig.json` or `jsconfig.json` specifying your environment and any other relevant configuration. | |||
| 1. Consider disabling the built-in `vscode.typescript-language-features` extension for any workspaces where you use Glint to avoid extraneous diagnostics. <details><summary>Screenshot</summary> | |||
| 1. Consider disabling the built-in `vscode.typescript-language-features` extension for any workspaces where you use Glint to avoid extraneous diagnostics. | |||
There was a problem hiding this comment.
Should this use stronger wording?
Suggested change
| 1. Consider disabling the built-in `vscode.typescript-language-features` extension for any workspaces where you use Glint to avoid extraneous diagnostics. | |
| 1. Disable the built-in `vscode.typescript-language-features` extension for any workspaces where you use Glint to avoid extraneous diagnostics. |
I've seen a lot of people skip this, to only run into issues later and forget this step was recommended.
dfreeman
reviewed
Aug 1, 2023
chriskrycho
approved these changes
Aug 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As discussed here: https://discord.com/channels/480462759797063690/1135613767493881906/1135616206884323439
Also fixes the
<details>section for the screenshot which requires a newline to render properly.