Add documentation links to analyzer diagnostics - #4
Merged
cliedeman merged 2 commits intoMay 31, 2026
Merged
Conversation
Copilot created this pull request from a session on behalf of
cliedeman
May 31, 2026 11:54
View session
cliedeman
marked this pull request as ready for review
May 31, 2026 11:54
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.
Analyzer failures did not expose a direct path to the corresponding rule documentation, forcing users to manually look up guidance. This change attaches rule-specific documentation URLs to the emitted diagnostics so IDEs and tooling can surface the relevant docs inline.
What changed
helpLinkUrito every shipped analyzerDiagnosticDescriptor.docs/rules/....SWGQL05andSWGQL06.Implementation
DiagnosticHelpLinksmapping to keep rule-to-doc URLs centralized.Guardrails