Use MTP acronym consistently across Microsoft.Testing.Platform docs#53354
Open
Evangelink wants to merge 4 commits intomainfrom
Open
Use MTP acronym consistently across Microsoft.Testing.Platform docs#53354Evangelink wants to merge 4 commits intomainfrom
Evangelink wants to merge 4 commits intomainfrom
Conversation
Introduce the Microsoft.Testing.Platform (MTP) acronym on first prose mention in each documentation file and then use MTP throughout. This reduces repetition and improves readability. Full name is preserved in YAML frontmatter titles, code/JSON blocks, NuGet package names, namespace references, and xref links.
Restore original heading text for headings referenced by anchor links: - Microsoft.Testing.Platform profile (unit-testing-mstest-sdk.md) - Microsoft.Testing.Platform services (architecture-services.md) - Microsoft.Testing.Platform-related properties (msbuild-props.md) These headings generate anchors used by cross-file links.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes the use of the Microsoft.Testing.Platform (MTP) acronym across the .NET documentation set to reduce repetition and improve readability when referring to the platform.
Changes:
- Introduces
Microsoft.Testing.Platform (MTP)on first mention per file and usesMTPfor subsequent prose mentions. - Updates headings, link text, and narrative content to prefer the acronym while keeping code literals, package names, and
xref:references intact. - Adjusts related docs (SDK “what’s new”, CLI docs, and testing guides) to use consistent terminology.
Show a summary per file
| File | Description |
|---|---|
| docs/core/whats-new/dotnet-10/sdk.md | Uses MTP terminology in the .NET 10 SDK “dotnet test” section. |
| docs/core/whats-new/dotnet-10/overview.md | Updates overview text to introduce and use the MTP acronym. |
| docs/core/tutorials/test-class-library.md | Updates tutorial text to reference MTP when selecting the test runner. |
| docs/core/tools/global-json.md | Introduces MTP acronym when describing the test runner configuration. |
| docs/core/tools/dotnet-test.md | Updates runner selection guidance to use MTP acronym. |
| docs/core/tools/dotnet-test-vstest.md | Updates explanatory note to introduce MTP acronym in link text. |
| docs/core/tools/dotnet-test-mtp.md | Updates title/description/body wording to use MTP consistently. |
| docs/core/tools/dotnet-new-sdk-templates.md | Updates template option descriptions to use MTP acronym. |
| docs/core/testing/unit-testing-with-dotnet-test.md | Renames “Microsoft.Testing.Platform mode” references to “MTP mode”. |
| docs/core/testing/unit-testing-nunit-runner-intro.md | Updates title/H1/body links to use MTP terminology. |
| docs/core/testing/unit-testing-mstest-sdk.md | Updates runner and extension terminology to prefer MTP. |
| docs/core/testing/unit-testing-mstest-running-tests.md | Updates headings and prose to prefer MTP after initial introduction. |
| docs/core/testing/unit-testing-mstest-migration-v3-v4.md | Updates migration notes to use MTP consistently. |
| docs/core/testing/unit-testing-mstest-migration-from-v1-to-v3.md | Updates “Additional resources” link text to MTP terminology. |
| docs/core/testing/unit-testing-mstest-intro.md | Updates recommendation sentence to refer to MTP. |
| docs/core/testing/unit-testing-mstest-getting-started.md | Updates tip and package bullets to refer to MTP. |
| docs/core/testing/unit-testing-mstest-configure.md | Updates link text to MTP terminology for configuration docs. |
| docs/core/testing/test-platforms-overview.md | Updates tables, headings, and guidance to prefer MTP terminology. |
| docs/core/testing/mstest-analyzers/mstest0040.md | Updates analyzer rule text to refer to MTP. |
| docs/core/testing/migrating-vstest-microsoft-testing-platform.md | Updates migration guide title/description/body to use MTP. |
| docs/core/testing/microsoft-testing-platform-troubleshooting.md | Updates troubleshooting title/description/body to use MTP. |
| docs/core/testing/microsoft-testing-platform-test-reports.md | Updates front matter to include MTP acronym and uses MTP in description. |
| docs/core/testing/microsoft-testing-platform-terminal-output.md | Updates front matter and body references to MTP. |
| docs/core/testing/microsoft-testing-platform-telemetry.md | Updates front matter and body references to MTP. |
| docs/core/testing/microsoft-testing-platform-run-and-debug.md | Updates front matter and narrative references to MTP. |
| docs/core/testing/microsoft-testing-platform-retry.md | Updates front matter to include MTP acronym and uses MTP in description. |
| docs/core/testing/microsoft-testing-platform-open-telemetry.md | Updates front matter and first prose mention to include MTP acronym. |
| docs/core/testing/microsoft-testing-platform-migration-from-v1-to-v2.md | Updates front matter and prose references to MTP. |
| docs/core/testing/microsoft-testing-platform-intro.md | Updates overview page H1/body to introduce and use MTP. |
| docs/core/testing/microsoft-testing-platform-hot-reload.md | Updates front matter and license wording to use MTP. |
| docs/core/testing/microsoft-testing-platform-features.md | Updates features page H1/body to prefer MTP after introduction. |
| docs/core/testing/microsoft-testing-platform-fakes.md | Updates front matter to include MTP acronym and uses MTP in description. |
| docs/core/testing/microsoft-testing-platform-extensions-vstest-bridge.md | Updates front matter/body to prefer MTP terminology. |
| docs/core/testing/microsoft-testing-platform-crash-hang-dumps.md | Updates front matter to include MTP acronym and uses MTP in description. |
| docs/core/testing/microsoft-testing-platform-config.md | Updates config page H1/body to use MTP after introduction. |
| docs/core/testing/microsoft-testing-platform-code-coverage.md | Updates front matter/body/table headers to use MTP. |
| docs/core/testing/microsoft-testing-platform-cli-options.md | Updates CLI options page title/H1/body to use MTP after introduction. |
| docs/core/testing/microsoft-testing-platform-architecture.md | Updates architecture landing page front matter/body to include MTP. |
| docs/core/testing/microsoft-testing-platform-architecture-test-framework.md | Updates front matter/body references to include MTP. |
| docs/core/testing/microsoft-testing-platform-architecture-services.md | Updates front matter/H1 to include MTP. |
| docs/core/testing/microsoft-testing-platform-architecture-extensions.md | Updates front matter/H1/body to include MTP. |
| docs/core/testing/microsoft-testing-platform-architecture-capabilities.md | Updates front matter/H1/body to include MTP. |
| docs/core/testing/index.md | Updates testing index references to introduce MTP and use it consistently. |
| docs/core/project-sdk/msbuild-props.md | Updates section heading and prose to use MTP terminology for related properties. |
Copilot's findings
Comments suppressed due to low confidence (2)
docs/core/project-sdk/msbuild-props.md:1522
- Changing this heading text will likely change the autogenerated anchor ID, which can break existing links (for example, links that use
#microsofttestingplatformrelated-properties). If you want to include "(MTP)" in the heading, add an explicit anchor that preserves the old fragment, or keep the heading text unchanged and introduce the acronym in the first paragraph of the section instead.
## Microsoft.Testing.Platform–related properties
docs/core/testing/unit-testing-mstest-sdk.md:33
- The in-page link uses
#microsofttestingplatform-profile, but the target heading was renamed to "MTP profile", which will change the autogenerated heading ID. Update the link fragment to match the new heading (or add an explicit anchor on the heading to preserve the old fragment).
- Files reviewed: 44/44 changed files
- Comments generated: 11
- Fix acronym not expanded on first visible use in terminal-output, telemetry, code-coverage, and sdk.md - Restore full name in NUnit runner title/H1 for discoverability - Add missing period after NUnit runner intro paragraph - Fix copy-paste error: TestingPlatformCaptureOutput -> TestingPlatformCommandLineArguments - Fix grammar: 'MTP test' -> 'MTP tests' (plural) - Convert non-procedural ordered list to bullets in vstest-bridge
- architecture-services.md: revert YAML title to match H1 (preserves #microsofttestingplatform-services anchor), fix awkward description - code-coverage.md: acronym already introduced in body paragraph before table; keep H1 as 'Code coverage' to avoid anchor churn
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.
Summary
Introduce the Microsoft.Testing.Platform (MTP) acronym on first prose mention in each documentation file and then use MTP throughout. This reduces repetition and improves readability across ~44 files.
Changes
Pattern applied
Microsoft.Testing.Platform (MTP)MTP(MTP)appended), code/JSON blocks, NuGet package names (Microsoft.Testing.Platform.MSBuild), namespace/API references,xref:links, andglobal.jsonrunner valuesFiles touched (44 files)
ai-usage: ai-assisted
Relates to #51830
Internal previews
Toggle expand/collapse
dotnet newNote
This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.