Skip to content

Add installation instructions and improve rules documentation format#9

Merged
einari merged 2 commits into
mainfrom
copilot/documentation-index-rules-table
Jun 2, 2026
Merged

Add installation instructions and improve rules documentation format#9
einari merged 2 commits into
mainfrom
copilot/documentation-index-rules-table

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Documentation lacked installation instructions and the rules index needed a description column for better discoverability.

Changes

  • README.md: Added installation section with dotnet add package command and .csproj reference example
  • Rules documentation: Added Description column to both index files (Documentation/CodeAnalysis/index.md and Documentation/CodeAnalysis/Rules/index.md) matching Chronicle's format

The rules overview now includes:

Rule ID Title Severity Description
CRARCH0001 Exception type naming Warning Exception types must use domain terminology and avoid the generic Exception suffix
... ... ... ...

This makes it easier to scan available rules without clicking through to individual pages.

@einari einari marked this pull request as ready for review June 2, 2026 12:52
@einari einari merged commit b243149 into main Jun 2, 2026
@einari einari deleted the copilot/documentation-index-rules-table branch June 2, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants