Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 19, 2025

  • Analyze existing documentation structure and issues
  • Add Windows-specific warning about Program Files installation issues for BlazorWebView
  • Add Windows-specific warning about Program Files installation issues for WebView
  • Add Windows-specific warning about Program Files installation issues for HybridWebView
  • Include workaround solution using WEBVIEW2_USER_DATA_FOLDER environment variable
  • Test documentation changes for proper formatting and links
  • Review committed changes to ensure minimal scope
  • Extract repeated warning text into reusable include snippet

Refactoring Summary

Per feedback from @jfversluis, extracted the repeated WebView2 Program Files warning into a reusable include snippet to eliminate duplication and improve maintainability.

Changes:

  • Created docs/user-interface/controls/includes/webview2-program-files-warning.md with the shared warning content
  • Replaced duplicate warning blocks in all three files with [!INCLUDE [WebView2 Program Files warning](includes/webview2-program-files-warning.md)]
  • Made the warning text more generic ("WebView2-based controls" and "any WebView control") to work for all three control types

Benefits:

  • Single source of truth for the warning content
  • Easier maintenance when updates are needed
  • Consistent messaging across all WebView-based controls
  • Follows established documentation patterns in the repository

The documentation now provides the same critical information about Program Files installation issues while following DRY (Don't Repeat Yourself) principles.

Fixes #2871.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 3f307e9:

✅ Validation status: passed

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 6831635:

✅ Validation status: passed

File Status Preview URL Details
docs/user-interface/controls/blazorwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/hybridwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/webview.md ✅Succeeded View (>=net-maui-8.0)

For more details, please refer to the build report.

Copilot AI changed the title [WIP] Document WebView2/BlazorWebView/HybridWebView issues with Program Files Document WebView2/BlazorWebView/HybridWebView issues with Program Files installation Sep 19, 2025
Copilot AI requested a review from jfversluis September 19, 2025 19:38
Copilot finished work on behalf of jfversluis September 19, 2025 19:38
@jfversluis
Copy link
Member

@copilot can we make the repeated text a snippet and include that in these three places?

Copy link
Contributor Author

Copilot AI commented Sep 19, 2025

@copilot can we make the repeated text a snippet and include that in these three places?

Done! I've extracted the repeated warning text into a reusable include snippet at docs/user-interface/controls/includes/webview2-program-files-warning.md and replaced all three instances with [!INCLUDE [WebView2 Program Files warning](includes/webview2-program-files-warning.md)]. This eliminates duplication and makes the content easier to maintain. (commit 56f0ff2)

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 56f0ff2:

💡 Validation status: suggestions

File Status Preview URL Details
docs/user-interface/controls/includes/webview2-program-files-warning.md 💡Suggestion View (>=net-maui-8.0) Details
docs/user-interface/controls/blazorwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/hybridwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/webview.md ✅Succeeded View (>=net-maui-8.0)

docs/user-interface/controls/includes/webview2-program-files-warning.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 56f0ff2:

💡 Validation status: suggestions

File Status Preview URL Details
docs/user-interface/controls/includes/webview2-program-files-warning.md 💡Suggestion View (>=net-maui-8.0) Details
docs/user-interface/controls/blazorwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/hybridwebview.md ✅Succeeded View (>=net-maui-8.0)
docs/user-interface/controls/webview.md ✅Succeeded View (>=net-maui-8.0)

docs/user-interface/controls/includes/webview2-program-files-warning.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

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.

Document WebView2/BlazorWebView/HybridWebView issues with Program Files

2 participants