Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Wiki for several issues #5234

Open
2 of 9 tasks
Youssef1313 opened this issue Jul 11, 2021 · 2 comments · May be fixed by #6383
Open
2 of 9 tasks

Update Wiki for several issues #5234

Youssef1313 opened this issue Jul 11, 2021 · 2 comments · May be fixed by #6383
Labels
Area-Infrastructure Documentation Enhancement help wanted The issue is up-for-grabs, and can be claimed by commenting

Comments

@Youssef1313
Copy link
Member

Youssef1313 commented Jul 11, 2021

https://github.com/dotnet/roslyn-analyzers/wiki

  • Install Instructions

  • Apply a Code Fix for a Rule

    • There is a dead image link due to the movement from master to main. This link should be fixed.
    • There is a statement saying not all 100 code analysis rules in this extension have fixes associated with them., if the number of rules is now much greater than 100, this should be fixed either by removing the number at all, or fix the number.
  • Configure a Rule

    • Dead image
    • It mentions ruleset, this should be updated for globalconfig and/or editorconfig
  • FAQ

    • Shouldn't mention rulesets, or mention them as obsolete/deprecated.
    • A question saying Does this work with EditorConfig? is answered by "No". This feels outdated.
    • Links to NuGet package are for the old FxCopAnalyzers, not NetAnalyzers.
@Evangelink Evangelink added Area-Infrastructure Enhancement help wanted The issue is up-for-grabs, and can be claimed by commenting labels Jul 26, 2021
@Youssef1313 Youssef1313 removed the help wanted The issue is up-for-grabs, and can be claimed by commenting label Dec 13, 2022
@Youssef1313
Copy link
Member Author

Removing "help wanted" since community contributors don't have access to update the Wiki.

@Youssef1313 Youssef1313 linked a pull request Dec 22, 2022 that will close this issue
@Youssef1313
Copy link
Member Author

Removing "help wanted" since community contributors don't have access to update the Wiki.

I think moving from GitHub Wiki to just a file makes more sense. I'm doing that in #6383.

@Youssef1313 Youssef1313 added the help wanted The issue is up-for-grabs, and can be claimed by commenting label Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Infrastructure Documentation Enhancement help wanted The issue is up-for-grabs, and can be claimed by commenting
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants