Rework the wiki #6383
Open
Rework the wiki #6383
Conversation
This file contains 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
9 tasks
mavasani
reviewed
Jan 3, 2023
docs/wiki.md
Outdated
|
|
||
| ## Install Instructions | ||
| You can download the FXCop live code analyzers as a [NuGet package](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/) or as a Visual Studio extension ([VS2017](https://marketplace.visualstudio.com/items?itemName=VisualStudioPlatformTeam.MicrosoftCodeAnalysis2017) or [VS2019](https://marketplace.visualstudio.com/items?itemName=VisualStudioPlatformTeam.MicrosoftCodeAnalysis2019)). | ||
| We've rebuilt the most popular FxCop rules and additional more rules as live analyzers to help you detect problems in your code and make it super easy for you to fix them on the spot with quick fixes. You can get the analyzers via [`Microsoft.CodeAnalysis.NetAnalyzers` NuGet package](https://www.nuget.org/packages/Microsoft.CodeAnalysis.NetAnalyzers) or from the .NET SDK. This gives you the same great code analysis as before with FXCop but now the analysis is live as-you-type and has quick-fixes. |
There was a problem hiding this comment.
I think we should avoid mentioning specific NuGet package, or .NET SDK or any acquisition modes here and instead just add a help link to https://learn.microsoft.com/dotnet/fundamentals/code-analysis/overview?tabs=net-7 which has all the relevant information.
mavasani
reviewed
Jan 3, 2023
docs/wiki.md
Outdated
| ## Apply a Code Fix for a Rule | ||
| Place your cursor in the span of the squiggle/dotted line and press `Ctrl+.` to trigger the lightbulb menu. From the lightbulb, you will see all available quick actions. | ||
| > Note: not all 100 code analysis rules in this extension have fixes associated with them. | ||
| ## Install instructions |
There was a problem hiding this comment.
Again, I think we should avoid repeating Install related information in our wiki as it is already covered in .NET code analysis docs.
mavasani
reviewed
Jan 3, 2023
docs/wiki.md
Outdated
|
|
||
| ## Apply a code fix for a rule | ||
|
|
||
| Place your cursor in the span of the squiggle/dotted line and press `Ctrl+.` to trigger the lightbulb menu. From the lightbulb, you will see all available quick actions. |
There was a problem hiding this comment.
Please avoid all the text here and instead just add a help link to https://learn.microsoft.com/visualstudio/ide/quick-actions
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.
For easier review, the first commit is an exact port of https://github.com/dotnet/roslyn-analyzers/wiki.
Later commits are the changes done to the Wiki.
If this PR gets merged, https://github.com/dotnet/roslyn-analyzers/wiki will need to be updated to only have a single link to the wiki in the repository.
You can also choose to close the PR and move these changes directly to the Wiki.
The benefit of having this as part of the repository is to enable community contributions.
Fixes #5234