Skip to content

Refresh doc/windows/package-manager/winget/ reference docs to match live CLI behavior - #6442

Open
Demitrius Nelon (denelon) wants to merge 2 commits into
microsoft:masterfrom
denelon:refresh-doc-mirror
Open

Refresh doc/windows/package-manager/winget/ reference docs to match live CLI behavior#6442
Demitrius Nelon (denelon) wants to merge 2 commits into
microsoft:masterfrom
denelon:refresh-doc-mirror

Conversation

@denelon

@denelon Demitrius Nelon (denelon) commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

📖 Description

Refreshes the doc/windows/package-manager/winget/ reference doc mirror to accurately reflect current live winget.exe CLI behavior (v1.30.100-preview) while preserving the existing Microsoft Learn reference content:

  • Updates 13 existing command pages to match live --help output, including current aliases, subcommands, and options such as --dependencies-only on install.
  • Adds 6 pages for previously undocumented top-level commands: pin, configure, download, repair, dscv3, and mcp.
  • Updates index.md to list and link all 19 top-level commands.
  • Uses Microsoft Learn-style MM/DD/YYYY metadata dates across all 20 changed Markdown files.
  • Retains the existing command screenshots and detailed settings reference for source updates, progress-bar visuals, install behavior, telemetry, and networking.

This mirror is intended as a staging area to validate CLI doc changes locally before contributing corrected content upstream to Microsoft Learn.

Created with GitHub Copilot's assistance.

🔗 References

Resolves #6441

🔍 Validation

Compared every command page against the exact output of winget --help, winget <command> --help, and relevant subcommand --help output from the installed v1.30.100-preview client. Also verified:

  • The diff remains limited to 20 Markdown files under doc/windows/package-manager/winget/.
  • All changed pages use ms.date: 08/06/2026.
  • The eight restored image references resolve to existing files.
  • index.md contains 19 top-level command rows.
  • The restored settings reference retains the refreshed command aliases, subcommands, and options.

✅ Checklist

📋 Issue Type

  • Bug fix
  • Feature
  • Task
Microsoft Reviewers: Open in CodeFlow

- Updated install.md, upgrade.md, show.md, source.md, search.md, list.md,
  uninstall.md, hash.md, validate.md, settings.md, features.md, export.md,
  import.md to reflect current live winget --help output (v1.30.100-preview),
  fixing stale/missing options (e.g. --dependencies-only on install).
- Updated index.md to list and link all 18 top-level commands.
- Added new pages for previously undocumented commands: pin.md, configure.md,
  download.md, repair.md, dscv3.md, mcp.md.

This mirror is intended as a staging area to validate CLI doc changes locally
before contributing corrected content upstream to Microsoft Learn
(windows-dev-docs-pr).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@denelon
Demitrius Nelon (denelon) marked this pull request as ready for review August 6, 2026 21:48
@denelon
Demitrius Nelon (denelon) requested a review from a team as a code owner August 6, 2026 21:48

@ranm-msft ranm-msft left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I spot-checked this against a live client (v1.30.110-preview) rather than just reading the diff, and the accuracy claim holds up well:

  • install.md's option table matches winget install --help exactly - every option, same order, identical descriptions (including --dependencies-only).
  • mcp.md matches winget mcp --help exactly.
  • index.md lists every top-level command in the same order as winget --help, and the help.md / returnCodes.md links resolve.

Three things I'd like to see addressed before this merges:

  1. ms.date format. All 20 files switch to ISO (ms.date: 2026-08-06), but every page previously used MM/DD/YYYY (05/05/2021, 04/28/2020), which is the Microsoft Learn convention. Since this folder is explicitly a staging area for upstreaming to Learn, these would have to be converted back before contributing. Worth fixing here so the mirror stays copy-paste ready - it's 20 one-line edits.

  2. Orphaned screenshots. Eight images are dereferenced but the files remain in images/: install.png, help.png, export-command.png, import-command.png, source-list.png, source-list-winget.png, uninstall-execute.png, uninstall-with-list.png. The live Learn pages still show most of these. Either keep the references or delete the now-unused files, so the mirror doesn't drift from Learn in a way that's invisible in review.

  3. settings.md content deletion. This drops roughly 100 lines of hand-written reference (source.autoUpdateIntervalInMinutes, visual.progressBar, the installBehavior preferences/requirements explanation) in favor of a pointer to aka.ms/winget-settings. That's defensible de-duplication, but it's a real content removal rather than a refresh - could you confirm it's intentional and that nothing here is unique to this page?

Minor: the description says "all 18 top-level commands"; there are 19. The table itself is complete, so it's just the prose.

Happy to approve once 1 and 2 are handled and 3 is confirmed.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

@ranm-msft ranm-msft left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for turning this around so quickly. Re-reviewed at d2bc70d1 -- all three items from my previous review are resolved, and I verified each against the head commit rather than taking the diff at face value.

1. ms.date format -- Fixed. Checked all 20 files individually at head; every one is now 08/06/2026 (MM/DD/YYYY), matching the Learn convention for this staging mirror.

2. settings.md content -- Fixed. The ~112 lines are restored: "Updating settings", Source / autoUpdateIntervalInMinutes, Visual / progressBar, Install behavior (preferences vs requirements, scope, locale), Telemetry, Network / downloader, and "Enabling experimental features".

3. Orphaned screenshots -- Fixed, and handled better than what I suggested. Rather than deleting the images, you restored the prose that references them (export.md, import.md, uninstall.md, source.md, index.md). I re-ran the reference audit against head: 25 images in images/, 25 referenced, zero orphans.

Also re-confirmed the accuracy claim still holds against a live CLI on my box (v1.30.110-preview): index.md lists all 19 top-level commands in CLI order, and the install / mcp option tables still match --help output exactly.

CI is green (Check Spelling and CLA pass; winget-cli Build_Test is neutral/skipped, expected for a docs-only change).

LGTM -- approving.

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.

Refresh doc/windows/package-manager/winget/ reference docs to match live CLI behavior

2 participants