Skip to content

Rebrand C# Health Check docs as C# Doctor - #3494

Draft
Jake (JakeRadMSFT) wants to merge 7 commits into
mainfrom
dev/jakerad/csharp-doctor-public-docs
Draft

Rebrand C# Health Check docs as C# Doctor#3494
Jake (JakeRadMSFT) wants to merge 7 commits into
mainfrom
dev/jakerad/csharp-doctor-public-docs

Conversation

@JakeRadMSFT

@JakeRadMSFT Jake (JakeRadMSFT) commented Sep 8, 2026

Copy link
Copy Markdown
Member

C# Dev Kit’s approved user-facing experience name is now C# Doctor, and its Command Palette title is C#: Check health with C# Doctor. This updates the public documentation so first-time users see the same names as the product UI without turning every descriptive use of “health check” into branding.

Important

Release-order gate: Do not merge this pull request until the vs-green C# Doctor change !778912 ships. Public documentation must not introduce the new naming before the product. The docs are synchronized to the final vs-green product head f91bf0911534ea014336e3f5c6caf4df69d326d4; its extension content is byte-identical to built merge head 18e1f12ffb02d2adb5f6d2e16f1eb5040c1c5e4a. After !778912 lands, verify the landed product still uses the approved wording before merging.

Changes

  • Define C# Doctor naturally as C# Dev Kit’s health-check view, then explain its tooling, runtime, stage, and recovery behavior.
  • Use C# Doctor when naming the view or user experience and natural-language “health check” wording when describing the process or behavior.
  • Update manual command instructions to say “Open C# Doctor” and “Run C#: Check health with C# Doctor.”
  • Title the installation guide Install and manage .NET with C# Doctor without treating an unverified SDK installation phrase as an exact action label.
  • Clarify the SDK recommendation and offline-workspace guidance.
  • Update README navigation labels while preserving their destinations.
  • Preserve legacy generated heading fragments with explicit anchors.
  • Add a scoped README contribution rule for auditing these stable docs when the vs-green behavior or UX copy changes.

Source of truth and future updates

For maintainers with access, the vs-green implementation and approved UX copy remain the source of truth for the C# Doctor name, command, actions, states, setup, troubleshooting, and screenshots. A corresponding behavior or UX change should audit docs/health-check.md and the related guides in a linked documentation PR. The vs-green and documentation PRs should link to each other.

Compatibility

File paths, documentation URLs, relative internal links, link destinations, anchors, and aka.ms targets are unchanged. In particular, docs/health-check.md and every existing health-check* path remain in place. Explicit legacy anchors preserve fragments that would otherwise change with rebranded headings.

Redirect follow-up

None. This repository contains no health-check-related aka.ms alias or redirect configuration; the unrelated license and security aliases remain unchanged.

Editorial review

An independent editorial pass clarified the opening definition, installation-consent wording, SDK-recommendation heading, offline introduction, and maintainer freshness rule. The current guides contain no C# Doctor screenshots or related alt text to update.

Checks

  • Verified all three manual Command Palette instructions use the exact approved C#: Check health with C# Doctor label.
  • Verified old public labels no longer appear in repository documentation.
  • Validated relative Markdown links and preserved legacy anchors.
  • Verified the exact installation H1 and retained legacy fragment.
  • Verified the committed diff has no whitespace errors.

Jake (JakeRadMSFT) and others added 4 commits September 8, 2026 11:07
Update public documentation and command-title wording while preserving existing file paths, link targets, and legacy heading anchors.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Distinguish the product name from descriptive health-check prose and add a scoped contribution rule for keeping the stable docs aligned with vs-green.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Use "with C# Doctor" so the title describes managing .NET through the experience without implying that .NET is installed for the tool.`n`nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Clarify the C# Doctor introduction, installation consent, SDK recommendation, offline behavior, and maintainer freshness guidance.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@JakeRadMSFT
Jake (JakeRadMSFT) marked this pull request as ready for review September 8, 2026 22:09
Update every manual Command Palette instruction to match the approved vs-green label.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@JakeRadMSFT
Jake (JakeRadMSFT) marked this pull request as draft September 8, 2026 23:50
Jake (JakeRadMSFT) and others added 2 commits September 8, 2026 16:53
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

1 participant