feat(analyzers): improve diagnostic guidance

Merged
RE
2mo ago
+1624-237

Problem

OrleansContracts.txt did not show convention-derived grain and interface identities, so contract diffs could not clearly distinguish safe CLR renames from breaking Orleans identity changes. The manifest also needed clear generated-file guidance, and analyzer diagnostics lacked stable, actionable documentation links.

Solution

  • Record effective GrainType and GrainInterfaceType values in generated and checked-in contract manifests.
  • Add a canonical auto-generated header which links to https://aka.ms/orleans/OrleansContracts.txt for regeneration instructions.
  • Document how to regenerate active contracts while preserving retired identity history.
  • Add a diagnostics index and a dedicated reference page for every active Orleans analyzer diagnostic, plus the removed ORLEANS0003 rule for older packages.
  • Set each analyzer descriptor's help link to https://aka.ms/orleans/diagnostics#orleans#### so IDE users can open the relevant guidance.

Rationale

The manifest now makes identity-preserving and identity-breaking changes apparent during review and directs maintainers to a repeatable update workflow. Stable diagnostic links provide current guidance for impact, remediation, code fixes, and suppression without coupling released analyzer packages to the documentation site's physical URL structure.