Skip to content

Conversation

@martincostello
Copy link
Collaborator

  • Use mdsnippets to get code snippets in markdown from compile-validated code.
  • Use badges for dependency versions in README.
  • Add dependency of Microsoft.OpenApi to the README.

Cherry-picked from #3283.

- Use mdsnippets to get code snippets in markdown from compile-validated code.
- Use badges for dependency versions in README.
- Add dependency of Microsoft.OpenApi to the README.
@martincostello martincostello added dependencies Pull requests that update a dependency file .NET Pull requests that update .NET code documentation labels Oct 1, 2025
@codecov
Copy link

codecov bot commented Oct 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.28%. Comparing base (549e65b) to head (81d5870).
⚠️ Report is 3 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3592   +/-   ##
=======================================
  Coverage   94.28%   94.28%           
=======================================
  Files         110      110           
  Lines        3816     3816           
  Branches      723      723           
=======================================
  Hits         3598     3598           
  Misses        218      218           
Flag Coverage Δ
Linux 94.28% <ø> (ø)
Windows 94.28% <ø> (ø)
macOS 94.28% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Remove content that doesn't apply to v9.
Put OpenAPI first (and in bold to indicate the default), and 2.0 for Swagger second.
@martincostello martincostello marked this pull request as ready for review October 1, 2025 10:50
Copilot AI review requested due to automatic review settings October 1, 2025 10:50
@martincostello martincostello enabled auto-merge (squash) October 1, 2025 10:50
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces mdsnippets to extract code snippets from compiled C# code into documentation. It adds compile-validated code examples to markdown documentation, uses version badges for dependencies in the README, and creates a test project containing all the code snippets used throughout the documentation.

  • Add mdsnippets tooling to generate compile-validated code snippets in markdown
  • Create DocumentationSnippets test project with all example code
  • Update README and documentation files with snippet references and dependency version badges

Reviewed Changes

Copilot reviewed 42 out of 42 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
test/WebSites/DocumentationSnippets/ New test project containing all code examples used in documentation
mdsnippets.json Configuration file for mdsnippets tool
README.md Updated with snippet references and dependency version badges
docs/*.md Updated documentation files with mdsnippets references
.github/workflows/update-documentation.yml New workflow to automatically update documentation snippets
.config/dotnet-tools.json Added mdsnippets tool configuration

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Fix issues spotted by Copilot.
@martincostello martincostello merged commit 21a3668 into master Oct 1, 2025
13 checks passed
@martincostello martincostello deleted the documentation-snippets branch October 1, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation .NET Pull requests that update .NET code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants