docs: update installation instructions with recommended PackageReference sample and disabled-by-default rules - #3
Merged
Conversation
…n installation instructions
… installation instructions
Copilot created this pull request from a session on behalf of
cliedeman
May 31, 2026 11:25
View session
cliedeman
approved these changes
May 31, 2026
cliedeman
marked this pull request as ready for review
May 31, 2026 11:28
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.
Two gaps in the installation docs: the
PackageReferencesnippet didn't match the recommended form from the root README, and the editorconfig sample omitted rules that are off by default.Changes
docs/docs/intro.md— PackageReference format: replacedPrivateAssets="all"withOutputItemType="Analyzer" ReferenceOutputAssembly="false", consistent with the rootREADME.mddocs/docs/intro.md— Rule configuration sample: addedSW002(unused method detection, disabled by default) with an inline comment flagging its opt-in nature and pointing to its docs for caveats