microsoft / microsoft/winget-cli

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

Open
#6,441 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Docs
Dominant language
C++
Stars
26.4k
Forks
1.8k
Avg merge
1d 11h
Merged PRs (30d)
15

Description

The local doc mirror at doc/windows/package-manager/winget/ has drifted significantly from the actual winget.exe CLI behavior (currently v1.30.100-preview):

  • Several command pages were missing options that exist in live --help output (e.g. install.md was missing --dependencies-only).
  • upgrade.md was especially stale, last substantively updated in 2023, missing 10+ current options.
  • 6 of the 18 top-level winget commands had no documentation page at all: pin, configure, download, repair, dscv3, and mcp (the newest command).
  • index.md's command table didn't link or list all current commands.

This PR refreshes all existing pages against live --help output and adds the 6 missing command pages, so this folder can serve as an accurate staging area for validating CLI documentation changes locally before contributing corresponding fixes upstream to Microsoft Learn.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in doc/windows/package-manager/winget/ and compare the existing command pages and index.md with live winget.exe v1.30.100-preview --help output. Refresh the existing pages, add pin, configure, download, repair, dscv3, and mcp, and update the command table so all 18 commands are covered and linked.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.