Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the NetAnalyzers documentation set by renaming the analyzer configuration doc to a kebab-case filename and updating in-repo references/packaging accordingly, while also adding several new documentation pages and assets under src/Microsoft.CodeAnalysis.NetAnalyzers/docs.
Changes:
- Rename/update references to the analyzer configuration documentation file (
analyzer-configuration.md) in source comments and NuGet packing. - Update existing docs to point at the renamed configuration doc.
- Add multiple new documentation pages (performance workflow, getting-started, contribution guidelines, FxCop porting docs) and related assets (CSV inventory, PNG).
Reviewed changes
Copilot reviewed 4 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Microsoft.CodeAnalysis.NetAnalyzers/src/Utilities/FlowAnalysis/Options/EditorConfigOptionNames_FlowAnalysis.cs | Updates the “keep in sync with docs” comment to the new doc filename. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/src/Utilities/Compiler/Options/EditorConfigOptionNames.cs | Updates the “keep in sync with docs” comment to the new doc filename. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/src/Microsoft.CodeAnalysis.NetAnalyzers.Package.csproj | Packs the renamed configuration doc and updates the configuration filename property. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/writing-dataflow-analysis-based-analyzers.md | Updates links to analyzer configuration documentation. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/performance.md | Adds new documentation describing a proposed analyzer performance measurement workflow. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/netcore-getting-started.md | Adds new getting-started guidance for analyzer development. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/make-static.png | Adds a new image asset. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/guidelines-for-new-rules.md | Adds contribution guidelines for proposing/adding new CA rules. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/rules-inventory.csv | Adds a rules inventory CSV for FxCop porting/tracking. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/proposed-fxcop-rule-changes-in-roslyn.md | Adds documentation describing proposed deviations from FxCop behavior. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/porting-fxcop-rules-to-roslyn.md | Adds background/design doc for porting rules from FxCop to Roslyn analyzers. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/documenting-your-analyzers.md | Adds documentation guidance for writing analyzer reference docs. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/analyzer-reference-page-template.md | Adds a template for analyzer reference pages. |
| src/Microsoft.CodeAnalysis.NetAnalyzers/docs/analyzer-configuration.md | Adds the renamed analyzer configuration documentation file/content. |
Comments suppressed due to low confidence (1)
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/writing-dataflow-analysis-based-analyzers.md:152
- These links point to the
v2.9.7tag, but the doc filename was changed toanalyzer-configuration.md. Unless that tag also contains the renamed file, these URLs will 404. Consider linking tomainfor the configuration doc, or keep the old filename for tagged URLs.
krwq
commented
Apr 10, 2026
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
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.
Some renames because I now own this and have OCD