docs: fix factual inaccuracies surfaced by docs-vs-code validation#478
Merged
Conversation
Validates docs against the live CLI schema and source. Fixes: usage.md - update: remove non-existent --config-dir, fix ----setup-sdks typo - package --output: default is <name>_<version>_<arch>.msix (with fallbacks) - create-debug-identity --manifest: default is auto-detect, not ./appxmanifest.xml - manifest generate --if-exists: corrected description (manifest, not certificate) ui-automation.md - Fix "no global input injection" claim (ui click does inject) - Remove fictional [N] index disambiguation section (no parser support); replace with slug-based guidance - Fix screenshot description: multi-window output is composited into one PNG - Clarify foreground-before-capture only applies to --capture-screen / blank-frame retry - Document wait-for --contains - set-value: value is positional, not --text npm-usage.md - Fix execWithBuildTools return type: Buffer | string guides/rust.md - Remove redundant winapp manifest add-alias (already covered in step 4) PackageCommand.cs - Update --output help text to match actual default-name logic in MsixService.cs - Regenerated cli-schema.json, npm command wrappers, and SKILL.md tables Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates WinApp documentation and generated artifacts to align with the live CLI schema/source code, correcting previously documented flags and behaviors (especially around packaging defaults and UI automation).
Changes:
- Corrected docs for CLI options/behavior (
update,package --output, manifest auto-detect, UI automation selectors/screenshot/set-value). - Updated
package --outputhelp text in the CLI and propagated it through regenerated schema/docs/npm wrappers. - Removed a redundant step from the Rust guide.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/winapp-npm/src/winapp-commands.ts | Regenerated npm command typings/help text to reflect current CLI behavior. |
| src/winapp-CLI/WinApp.Cli/Commands/PackageCommand.cs | Updated --output option help text for the package/pack command. |
| docs/usage.md | Corrected CLI usage docs (removed nonexistent flags, fixed typos, updated defaults/semantics). |
| docs/ui-automation.md | Corrected UI automation behavior (click injection, selector disambiguation guidance, screenshot output, set-value args, wait-for examples). |
| docs/npm-usage.md | Updated npm usage docs to match current manifest expectations and packaging defaults. |
| docs/guides/rust.md | Removed redundant manifest add-alias step. |
| docs/cli-schema.json | Regenerated CLI schema to match updated help text. |
| .github/plugin/skills/winapp-cli/package/SKILL.md | Updated generated skill table for package --output help text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Build Metrics ReportBinary Sizes
Test Results✅ 773 passed, 1 skipped out of 774 tests in 440.4s (+30.7s vs. baseline) Test Coverage❌ 21.4% line coverage, 36.4% branch coverage · ✅ +0.5% vs. baseline CLI Startup Time42ms median (x64, Updated 2026-04-21 18:03:36 UTC · commit |
chiaramooney
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Validates docs against the live CLI schema and source code, then fixes the factual inaccuracies that surfaced.
Critical fixes
docs/usage.mdupdate: remove non-existent--config-dir, fix----setup-sdkstypo (only--setup-sdksis real)package --output: default is<name>_<version>_<arch>.msix(with fallbacks), not<name>_<version>.msixcreate-debug-identity --manifest: default is auto-detect (Package.appxmanifestthenappxmanifest.xml), not./appxmanifest.xmlmanifest generate --if-exists: described the wrong thing (said "certificate file"; it's the manifest file)docs/ui-automation.mdui clickdoes inject mouse input[N]index disambiguation section — there is no selector parser support for it; replaced with the real "use the slug from search output" guidancescreenshot: multi-window output is composited into one PNG, not separate files--capture-screen/ blank-frame retryset-value: value is a positional argument, not--textwait-for --containsexampledocs/npm-usage.mdexecWithBuildToolsreturn type:Buffer | string(matchesbuildtools-utils.ts)docs/guides/rust.mdwinapp manifest add-aliasin step 6 — alias is already added via the same CLI command in step 4src/winapp-CLI/.../PackageCommand.cs--outputhelp text to match the actual default-name logic inMsixService.cs:388-394cli-schema.json, npm command wrappers, and SKILL.md tables (autogen)Items intentionally not in this PR (per discussion)
upgradecommand docs — belongs in a different branchappxmanifest.xml→Package.appxmanifestrefresh across guides — separate change.debugsuffix — was a false positive (winapp rundoesn't add.debug; that's onlycreate-debug-identity)Validation
dotnet buildclean (0 warnings, 0 errors)Commands/*.cs,Services/*.cs,src/winapp-npm/src/*.ts, and live--cli-schemaoutput