From 7999a5de65163e54ec14ad1507fcbf3378d34836 Mon Sep 17 00:00:00 2001 From: John Kennedy Date: Thu, 26 Mar 2026 08:43:23 -0700 Subject: [PATCH] docs: fix multiple documentation issues - Add downloadBehavior and defaultDownloadDirectory to Settings.md (#5296) - Add PowerShell module section with cmdlet examples to README.md (#5921) - Add missing resume experimental feature to settings schema (#5108) - Add AppInstaller reset commands to troubleshooting guide (#4372) - Fix broken dscv3 help link pointing to Bing instead of docs (#5867) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 29 +++++++++++++++++++ doc/Settings.md | 16 ++++++++++ doc/troubleshooting/README.md | 3 ++ .../JSON/settings/settings.schema.0.2.json | 5 ++++ .../Commands/DscCommand.cpp | 2 +- 5 files changed, 54 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d30ccaac6f..0ec2c4d65f 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,35 @@ The same Microsoft Store package will be made available via our [Releases](https Please read our [troubleshooting guide](/doc/troubleshooting/README.md). +## PowerShell Module + +The [Microsoft.WinGet.Client](https://www.powershellgallery.com/packages/Microsoft.WinGet.Client/) PowerShell module provides native cmdlets for interacting with the Windows Package Manager. You can install it from the PowerShell Gallery: + +```powershell +Install-Module -Name Microsoft.WinGet.Client +``` + +Example usage: + +```powershell +# Search for a package +Find-WinGetPackage -Query "Visual Studio Code" + +# Install a package +Install-WinGetPackage -Id Microsoft.VisualStudioCode + +# List installed packages +Get-WinGetPackage + +# Update a package +Update-WinGetPackage -Id Microsoft.VisualStudioCode + +# Repair the WinGet package manager installation +Repair-WinGetPackageManager +``` + +For more information, see the [Microsoft.WinGet.Client](https://www.powershellgallery.com/packages/Microsoft.WinGet.Client/) page on the PowerShell Gallery. + ## Administrator Considerations Installer behavior can be different depending on whether you are running **WinGet** with administrator privileges. diff --git a/doc/Settings.md b/doc/Settings.md index 675d859dea..4915f81afa 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -248,6 +248,22 @@ The `defaultModuleRoot` behavior affects the default root directory where module }, ``` +## Download Behavior + +The `downloadBehavior` settings affect the default behavior of downloading packages. + +### Default Download Directory + +The `defaultDownloadDirectory` setting affects the default directory where installers are downloaded to. Defaults to `%USERPROFILE%/Downloads/` if value is not set or is invalid. + +> Note: This setting value must be an absolute path. + +```json + "downloadBehavior": { + "defaultDownloadDirectory": "C:/Users/FooBar/Downloads" + }, +``` + ## Telemetry The `telemetry` settings control whether winget writes ETW events that may be sent to Microsoft on a default installation of Windows. diff --git a/doc/troubleshooting/README.md b/doc/troubleshooting/README.md index 28b7b6fbde..f3eb86f18a 100644 --- a/doc/troubleshooting/README.md +++ b/doc/troubleshooting/README.md @@ -113,6 +113,9 @@ These errors most commonly occur for one of following reasons. Please try out th 1. Get the `PackageFullName` of your installed `App Installer` package (PowerShell): `Get-AppxPackage Microsoft.DesktopAppInstaller | Select Name, PackageFullName`. 2. `Add-AppxPackage -register "C:\Program Files\WindowsApps\{PackageFullName}\appxmanifest.xml" -DisableDevelopmentMode` (where `{PackageFullName}` is the info from the previous point). 3. Toggle the App Execution Alias for winget, again (see above). +5. The App Installer package may be in a broken state. You can try resetting it using PowerShell: + * On **Windows 11**: `Get-AppxPackage Microsoft.DesktopAppInstaller | Reset-AppxPackage` + * On **Windows 10**: `$Manifest = (Get-AppxPackage Microsoft.DesktopAppInstaller).InstallLocation + '\appxmanifest.xml'; Add-AppxPackage -DisableDevelopmentMode -Register $Manifest` If the above guidelines do not resolve the problem, please open an issue with details of the Windows version and App Installer version you are using. diff --git a/schemas/JSON/settings/settings.schema.0.2.json b/schemas/JSON/settings/settings.schema.0.2.json index 4cc0c632d3..25b04e3d1f 100644 --- a/schemas/JSON/settings/settings.schema.0.2.json +++ b/schemas/JSON/settings/settings.schema.0.2.json @@ -329,6 +329,11 @@ "type": "boolean", "default": false }, + "resume": { + "description": "Enable support for some commands to resume", + "type": "boolean", + "default": false + }, "sourcePriority": { "description": "Enable source priority feature", "type": "boolean", diff --git a/src/AppInstallerCLICore/Commands/DscCommand.cpp b/src/AppInstallerCLICore/Commands/DscCommand.cpp index 3b88245e83..e467825fd4 100644 --- a/src/AppInstallerCLICore/Commands/DscCommand.cpp +++ b/src/AppInstallerCLICore/Commands/DscCommand.cpp @@ -64,7 +64,7 @@ namespace AppInstaller::CLI Utility::LocIndView DscCommand::HelpLink() const { - return "https://aka.ms/winget-dsc-resources"_liv; + return "https://learn.microsoft.com/windows/package-manager/configuration/"_liv; } void DscCommand::ExecuteInternal(Execution::Context& context) const