Skip to content

[develop] Fix: Tutorial build issues — missing imports, packages, handlers, and CLI guidance#20

Open
qiutongMS wants to merge 3 commits into
docsfrom
fix/develop/doc-verification-tutorial-fixes
Open

[develop] Fix: Tutorial build issues — missing imports, packages, handlers, and CLI guidance#20
qiutongMS wants to merge 3 commits into
docsfrom
fix/develop/doc-verification-tutorial-fixes

Conversation

@qiutongMS
Copy link
Copy Markdown
Owner

Summary

  • combine all 5 doc-verification fix reports into one PR
  • add missing imports, package steps, handler/control guidance, and packaged WinUI CLI build notes
  • update stale Copilot CLI plugin and packaging commands

Completeness check

  • Findings in reports: 25
  • Files modified: 21
  • Findings addressed: 24
  • Notes: multiple findings mapped to the same page (for example, windows-hello-auth-service.md, windows-hello-login.md, and �i-build.md)

Skipped Findings

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@qiutongMS
Copy link
Copy Markdown
Owner Author

Summary: I reviewed the latest PR diff and the full content of all 21 modified files. I found 2 blocking issues: one incorrect Copilot plugin install identifier, and one Win2D tutorial section that still contradicts itself about whether the sample lives in MainWindow or MainPage files.

Must-fix issues:

  1. hub/apps/how-tos/ai-setup.md (Step 2, lines 57-60): The PR changes the install command to copilot plugin install winui@awesome-copilot, but the current Learn guidance still uses winui3-development@awesome-copilot. The follow-up copilot plugin list text also tells readers to look for the wrong plugin name. This would give readers the wrong install target.
  2. hub/apps/develop/win2d/quick-start.md ("Animate your app with CanvasAnimatedControl", around lines 243 and 298): the new note says the final WinUI 3 sample stays in MainWindow.xaml / MainWindow.xaml.cs, but the surrounding steps still instruct readers to switch to MainPage.xaml and to move code into the MainPage class. Those conflicting instructions leave the tutorial internally inconsistent and can still send readers to the wrong files.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@qiutongMS
Copy link
Copy Markdown
Owner Author

Summary: I reviewed the latest PR diff and the full content of each modified file. I found several blocking issues where the updated docs either use invalid commands or leave readers with contradictory/incorrect instructions.

Must-fix issues:

  1. hub/apps/how-tos/ai-build.md (Part 5: Package the app): The command uses winapp package, but the current WinApp CLI command is winapp pack. The official CLI usage docs list winapp pack <input-folder> [options]; winapp package is not documented and will mislead readers.
  2. hub/apps/how-tos/ai-setup.md (Step 2): The install command and follow-up verification text use winui@awesome-copilot, but the official Awesome Copilot WinUI 3 plugin identifier is winui3-development@awesome-copilot. As written, the setup steps point readers to the wrong plugin id.
  3. hub/apps/develop/win2d/quick-start.md (Correctly dispose of Win2D resources): The walkthrough is framed around MainWindow.xaml, but this section still tells readers to change a <Page ... Unloaded="Page_Unloaded"> root. That leaves the updated MainWindow-based instructions internally inconsistent and breaks the reader flow.
  4. hub/apps/develop/notifications/app-notifications/app-notifications-quickstart.md (Handle activation from an app notification): The prose says readers should check for ExtendedActivationKind.AppNotification, then immediately says cold-start activation is reported as Launch, not AppNotification. That contradiction needs to be resolved so the code path matches the explanation.
  5. hub/apps/develop/ui/navigation/navigate-between-two-pages.md (Page2.xaml.cpp sample): The C++ handler under the Page2 section is still declared as winrt::BasicNavigation::implementation::MainPage::HyperlinkButton_Click(...) instead of Page2::HyperlinkButton_Click(...), so the sample remains technically incorrect.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@qiutongMS
Copy link
Copy Markdown
Owner Author

Review Result: CHANGES_REQUESTED

Summary

The PR correctly adds missing using directives, TIP callouts for command-line build, and a meaningful lambda syntax-error fix in windows-hello-auth-service.md. One must-fix issue found: the winapp package command in ai-build.md references a win-x64 subdirectory created only by dotnet publish -r win-x64, NOT by the preceding dotnet build -p:Platform=x64 -- readers will hit a path-not-found error.

Must-Fix Issues

# File Section Issue Severity
1 hub/apps/how-tos/ai-build.md Part 5 - Package the app winapp package source path uses win-x64 subdirectory that only exists after dotnet publish -r win-x64, not after dotnet build -p:Platform=x64. Either switch the preceding command to dotnet publish -r win-x64 --self-contained, or correct the path to the plain build output bin\x64\Debug<target-framework>. must-fix

Suggestions

# File Section Suggestion
1 hub/apps/develop/data-access/cosmos-db-data-access.md Set up your solution Newtonsoft.Json install step may be inaccurate for current Azure.Cosmos 3.x+ (which uses System.Text.Json). Should be version-scoped.
2 hub/apps/develop/data-access/sql-server-database.md First, set up your solution Recommends deprecated System.Data.SqlClient; prefer Microsoft.Data.SqlClient.
3 hub/apps/how-tos/ai-setup.md Step 2 Plugin identifier changed from winui3-development@awesome-copilot to winui@awesome-copilot with no migration note for existing users.

@qiutongMS
Copy link
Copy Markdown
Owner Author

Overall assessment: the PR is mostly solid, but one change introduces a broken packaging workflow in hub/apps/how-tos/ai-build.md.

Must-fix:

  1. In Part 5: Package the app, the new command sequence runs dotnet build -p:Platform=x64 and then packages from ./bin/x64/Debug/<target-framework>/win-x64.
  2. That win-x64 subfolder is not produced by dotnet build; it is typically created by dotnet publish -r win-x64.
  3. A reader following the new instructions will hit a directory-not-found failure.

Please either:

  • change the packaging input path to the actual dotnet build output directory, or
  • change the build step to a publish flow that really creates the win-x64 output.

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