Skip to content

Replace deprecated ms.topic values with concept-article in docfx.json#2210

Merged
adegeo merged 2 commits intomainfrom
copilot/update-ms-topic-deprecated-values
Mar 27, 2026
Merged

Replace deprecated ms.topic values with concept-article in docfx.json#2210
adegeo merged 2 commits intomainfrom
copilot/update-ms-topic-deprecated-values

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 27, 2026

ms.topic values conceptual and article are deprecated and must be replaced with concept-article.

Changes

  • dotnet-desktop-guide/docfx.json — Updated the two global fileMetadata defaults that applied "conceptual" to all WinForms and WPF Markdown files:
"ms.topic": {
  "winforms/**/**.md": "concept-article",
  "wpf/**/**.md": "concept-article",
  ...
}

No individual .md or .yml files required changes — the deprecated value was only set via the global docfx.json defaults, not in per-file frontmatter.

Original prompt

Problem

The ms.topic metadata values conceptual and article are deprecated and must be replaced with concept-article.

Scope of Changes

docfx.json

The file dotnet-desktop-guide/docfx.json contains deprecated ms.topic default values in its fileMetadata section. Specifically, these two entries use the deprecated "conceptual" value:

"ms.topic": {
  "winforms/**/**.md": "conceptual",
  "wpf/**/**.md": "conceptual",
  ...
}

Action: Update both "conceptual" values to "concept-article" in the ms.topic fileMetadata block in dotnet-desktop-guide/docfx.json. Do NOT change any other ms.topic values in that block (e.g., error-reference, reference, how-to, overview should remain as-is).

All .md and .yml files

Search ALL .md and .yml files under dotnet-desktop-guide/ for any YAML frontmatter containing ms.topic: conceptual or ms.topic: article. If any such files exist, update those values to ms.topic: concept-article.

Based on initial analysis, individual files do not appear to have ms.topic: conceptual or ms.topic: article in their frontmatter (they use values like overview, concept-article, whats-new, sample, etc.), but please verify by searching all files comprehensively. The conceptual value is applied globally via docfx.json rather 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 .md or .yml files that contain ms.topic: conceptual or ms.topic: article in their frontmatter to use concept-article instead.

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.topic values across the codebase.

Assistant: I found the key information. The docfx.json file has ms.topic set to "conceptual" for both winforms/**/**.md and wpf/**/**.md patterns. I also see many individual .md files with various ms.topic values. Let me now search more specifically for files with ms.topic: conceptual or ms.topic: article in their frontmatter.

Assistant: Based on my analysis, here's what I found:

  1. docfx.json — This is the key file. It contains global ms.topic defaults in the fileMetadata section, including "conceptual" values:

    "ms.topic": {
      "winforms/**/**.md": "conceptual",
      "wpf/**/**.md": "conceptual",
      ...
    }

    These two entries need to be updated from "conceptual" to "concept-article".

  2. Individual .md and .yml files — The lexical search did not find any files with ms.topic: conceptual or ms.topic: article in their frontmatter (the files that appeared in results have other values like overview, concept-article, whats-new, sample, upgrade-and-migration-article, include, error-reference, etc.). The conceptual value is applied globally via docfx.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.json has two deprecated ms.topic values of "conceptual" in its fileMetadata section:

"winforms/**/**.md": "conceptual",
"wpf/**/**.md": "conceptual",

Both need to be updated to "concept-article".

Individual .md and .yml files

Based on code search, individual files in the repository already use specific ms.topic values like overview, concept-article, whats-new, sample, upgrade-and-migration-article, error-reference, etc. in their frontmatter — not the deprecated conceptual or article values. The "conceptual" value is applied as a global default through docfx.json rather 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.

…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
Copilot AI requested a review from wadepickett March 27, 2026 21:07
Copy link
Copy Markdown
Contributor

@wadepickett wadepickett left a comment

Choose a reason for hiding this comment

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

Approved.

@wadepickett wadepickett marked this pull request as ready for review March 27, 2026 21:14
@wadepickett wadepickett requested review from adegeo and Copilot March 27, 2026 21:14
Copy link
Copy Markdown
Contributor

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

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.topic default for winforms/**/**.md from conceptual to concept-article.
  • Replaced the ms.topic default for wpf/**/**.md from conceptual to concept-article.

@adegeo adegeo merged commit 20a95ea into main Mar 27, 2026
14 checks passed
@adegeo adegeo deleted the copilot/update-ms-topic-deprecated-values branch March 27, 2026 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants