Add architecture docs and diagrams for all integrations#1927
Merged
Conversation
Expanded documentation with architecture overviews, Mermaid diagrams, and tables for core, collector, msbuild, console, and MTP packages. Clarified integration responsibilities, constraints, and limitations (including MTP test assembly coverage). No code changes; documentation only.
Bertk
added
documentation
chore
Contributor
There was a problem hiding this comment.
Pull request overview
Adds architecture-focused documentation to make Coverlet’s integration modes (VSTest collector, MSBuild, global tool/console, and MTP) easier to understand, including diagrams, dependency/functionality tables, and explicitly documented constraints (notably the MTP test-assembly coverage limitation raised in #1911).
Changes:
- Added “Architecture” sections (tables + Mermaid diagrams) to VSTest, MSBuild, and Global Tool docs.
- Clarified MTP limitations, including the
--coverlet-include-test-assemblybehavior. - Introduced a new consolidated architecture overview document with cross-package diagrams and a responsibility/constraint table.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Documentation/VSTestIntegration.md | Adds architecture overview, dependency table, Mermaid diagram, and constraints for coverlet.collector. |
| Documentation/MSBuildIntegration.md | Adds architecture overview, dependency table, Mermaid diagram, and constraints for coverlet.msbuild. |
| Documentation/GlobalTool.md | Adds architecture overview, dependency table, Mermaid diagram, and constraints for coverlet.console. |
| Documentation/Coverlet.MTP.Integration.md | Adds a limitation note for --coverlet-include-test-assembly tied to issue #1911. |
| Documentation/Coverlet.Architecture.md | New high-level architecture doc with dependency map, responsibilities table, and execution sequence diagram. |
Bertk
added a commit
to Bertk/coverlet
that referenced
this pull request
May 3, 2026
…erage#1927) * Add architecture docs and diagrams for all integrations Expanded documentation with architecture overviews, Mermaid diagrams, and tables for core, collector, msbuild, console, and MTP packages. Clarified integration responsibilities, constraints, and limitations (including MTP test assembly coverage). No code changes; documentation only. * Update documentation and settings for Coverlet integration and usage
This was referenced May 18, 2026
Merged
Open
Open
This was referenced May 20, 2026
Open
Merged
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.
Expanded documentation with architecture overviews, Mermaid diagrams, and tables for core, collector, msbuild, console, and MTP packages. Clarified integration responsibilities, constraints, and limitations (including MTP test assembly coverage). No code changes; documentation only.
#1911