Replace deprecated ms.topic values with concept-article in docfx.json#2210
Merged
Replace deprecated ms.topic values with concept-article in docfx.json#2210
Conversation
…in docfx.json Agent-Logs-Url: https://github.com/dotnet/docs-desktop/sessions/8b424598-2b1c-4a22-8443-69c255ce014b Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update deprecated ms.topic values to concept-article
Replace deprecated ms.topic values with concept-article in docfx.json
Mar 27, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates DocFX global metadata defaults to remove deprecated ms.topic values for WinForms and WPF content within the .NET Desktop Guide documentation build configuration.
Changes:
- Replaced the
ms.topicdefault forwinforms/**/**.mdfromconceptualtoconcept-article. - Replaced the
ms.topicdefault forwpf/**/**.mdfromconceptualtoconcept-article.
adegeo
approved these changes
Mar 27, 2026
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.
ms.topicvaluesconceptualandarticleare deprecated and must be replaced withconcept-article.Changes
dotnet-desktop-guide/docfx.json— Updated the two globalfileMetadatadefaults that applied"conceptual"to all WinForms and WPF Markdown files:No individual
.mdor.ymlfiles required changes — the deprecated value was only set via the globaldocfx.jsondefaults, not in per-file frontmatter.Original prompt
Problem
The
ms.topicmetadata valuesconceptualandarticleare deprecated and must be replaced withconcept-article.Scope of Changes
docfx.json
The file
dotnet-desktop-guide/docfx.jsoncontains deprecatedms.topicdefault values in itsfileMetadatasection. Specifically, these two entries use the deprecated"conceptual"value:Action: Update both
"conceptual"values to"concept-article"in thems.topicfileMetadata block indotnet-desktop-guide/docfx.json. Do NOT change any otherms.topicvalues in that block (e.g.,error-reference,reference,how-to,overviewshould remain as-is).All .md and .yml files
Search ALL
.mdand.ymlfiles underdotnet-desktop-guide/for any YAML frontmatter containingms.topic: conceptualorms.topic: article. If any such files exist, update those values toms.topic: concept-article.Based on initial analysis, individual files do not appear to have
ms.topic: conceptualorms.topic: articlein their frontmatter (they use values likeoverview,concept-article,whats-new,sample, etc.), but please verify by searching all files comprehensively. Theconceptualvalue is applied globally viadocfx.jsonrather than in individual files.Summary
The minimum required change is updating two values in
dotnet-desktop-guide/docfx.json:"winforms/**/**.md": "conceptual"→"winforms/**/**.md": "concept-article""wpf/**/**.md": "conceptual"→"wpf/**/**.md": "concept-article"Plus updating any individual
.mdor.ymlfiles that containms.topic: conceptualorms.topic: articlein their frontmatter to useconcept-articleinstead.The following is the prior conversation context from the user's chat exploration (may be truncated):
User: Update deprecated ms.topic frontmatter values across this repository
The ms.topic metadata values conceptual and article are deprecated and must be replaced with concept-article.
Scope of changes:
docfx.json (if present): If this repo contains a docfx.json file with a global-level ms.topic default set to conceptual or article, update it to concept-article.
All .md and .yml files: For every Markdown or YAML file that contains ms.topic: conceptual or ms.topic: article in its frontmatter, update the value to concept-article. Verify all .md and .yml files.
Action: Create a PR with these changes if any affected files are found.
Assistant:
I'll start by examining the repository structure and searching for the deprecated
ms.topicvalues across the codebase.Assistant: I found the key information. The
docfx.jsonfile hasms.topicset to"conceptual"for bothwinforms/**/**.mdandwpf/**/**.mdpatterns. I also see many individual.mdfiles with variousms.topicvalues. Let me now search more specifically for files withms.topic: conceptualorms.topic: articlein their frontmatter.Assistant: Based on my analysis, here's what I found:
docfx.json— This is the key file. It contains globalms.topicdefaults in thefileMetadatasection, including"conceptual"values:These two entries need to be updated from
"conceptual"to"concept-article".Individual
.mdand.ymlfiles — The lexical search did not find any files withms.topic: conceptualorms.topic: articlein their frontmatter (the files that appeared in results have other values likeoverview,concept-article,whats-new,sample,upgrade-and-migration-article,include,error-reference, etc.). Theconceptualvalue is applied globally viadocfx.json, not in individual file frontmatter.Let me create a PR with the necessary change to
docfx.json.Assistant: I've analyzed the repository and identified the necessary changes, then kicked off a PR creation. Here's a summary of what was found:
docfx.json(the key file to update)The file
dotnet-desktop-guide/docfx.jsonhas two deprecatedms.topicvalues of"conceptual"in itsfileMetadatasection:Both need to be updated to
"concept-article".Individual
.mdand.ymlfilesBased on code search, individual files in the repository already use specific
ms.topicvalues likeoverview,concept-article,whats-new,sample,upgrade-and-migration-article,error-reference, etc. in their frontmatter — not the deprecatedconceptualorarticlevalues. The"conceptual"value is applied as a global default throughdocfx.jsonrather than in individual file frontmatter.This pull request was created from Copilot chat.
💡 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.