Fix markdown report format documentation

[Copilot]

Pull Request

Description

The markdown report format documentation in README.md and docs/guide/guide.md did not match the actual implementation. The docs showed issues grouped by type/severity and hot-spots in table format, but the implementation outputs compiler-style format for both.

Corrected documentation:

• Project header: Added missing project name heading and dashboard link
• Conditions table: Fixed column count from 4 to 5 (added missing Comparator column)
• Issues output: Changed from grouped counts to compiler-style: src/File.cs(42): MAJOR BUG [rule] Message
• Security hot-spots: Changed from table format to compiler-style: src/File.cs(88): HIGH [category] Message

Actual format (from implementation):

# Example Project Sonar Analysis

**Dashboard:** <https://sonarcloud.io/dashboard?id=my_project>

**Quality Gate Status:** ERROR

## Conditions

| Metric | Status | Comparator | Threshold | Actual |
|:-------------------------------|:-----:|:--:|--------:|-------:|
| Coverage on New Code | ERROR | LT | 80 | 65.5 |

## Issues

Found 2 issues

src/Program.cs(42): MAJOR CODE_SMELL [csharpsquid:S1234] Remove this unused variable

## Security Hot-Spots

Found 1 security hot-spot

src/Database.cs(88): HIGH [sql-injection] Make sure using this SQL query is safe

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

• Code builds successfully: dotnet build --configuration Release
• All tests pass: dotnet test --configuration Release
• Code produces zero warnings

Code Quality

• Code formatting is correct: dotnet format --verify-no-changes
• New code has appropriate XML documentation comments
• Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

• Spell checker passes: cspell "**/*.{md,cs}"
• Markdown linter passes: markdownlint "**/*.md"
• YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

• Added unit tests for new functionality
• Updated existing tests if behavior changed
• All tests follow the AAA (Arrange, Act, Assert) pattern
• Test coverage is maintained or improved

Documentation

• Updated README.md (if applicable)
• Updated ARCHITECTURE.md (if applicable)
• Added code examples for new features (if applicable)
• Updated requirements.yaml (if applicable)

Additional Notes

Documentation-only change. No code modifications. All existing tests (74/74) pass with the corrected documentation.

Original prompt

I believe the README.md Markdown Report Format is not correct. Please review and correct the documentation - including any other locations that may contain the format such as the user guide.

Custom agent used: Documentation Writer
Expert agent for creating, updating, and maintaining project documentation including README, guides, and API documentation

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.