-
Notifications
You must be signed in to change notification settings - Fork 59
docs: Fix misleading Web Authentication documentation suggesting WebView usage #3012
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-moss-0c5b8040f-3012.eastus2.azurestaticapps.net |
Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
|
|
…vider description Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR corrects misleading documentation that incorrectly described WebAuthenticationProvider as using an embedded "web view" control. The documentation is updated to accurately reflect that the implementation uses the system's WebAuthenticationBroker API (or WinUIEx.WebAuthenticator on Windows), which displays a system browser or authentication window rather than an embedded WebView component.
Changes:
- Updated page title from "Authenticate Users with a Web View" to "Authenticate Users with Web Authentication"
- Replaced all "web view" references with "WebAuthenticationBroker API" or "system browser/authentication window"
- Clarified authentication flow descriptions to match actual implementation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
doc/Learn/Walkthrough/Authentication.Web.howto.md |
Updated title, heading, and multiple references throughout to replace "web view" with accurate WebAuthenticationBroker terminology |
doc/Learn/Authentication/HowTo-WebAuthentication.md |
Updated provider description and LoginStartUri documentation to specify WebAuthenticationBroker API usage |
doc/Learn/Authentication/AuthenticationOverview.md |
Updated Web provider description to match actual implementation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-moss-0c5b8040f-3012.eastus2.azurestaticapps.net |
1 similar comment
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-moss-0c5b8040f-3012.eastus2.azurestaticapps.net |
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-moss-0c5b8040f-3012.eastus2.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
GitHub Issue (If applicable): closes #
PR Type
What is the current behavior?
Documentation incorrectly states that
WebAuthenticationProvideruses a "web view" control, implying an embedded WebView component. The actual implementation usesWebAuthenticationBrokerAPI (system authentication window on most platforms) andWinUIEx.WebAuthenticatoron Windows.This creates confusion as evidenced by:
WebAuthenticationBrokerAPI being usedWhat is the new behavior?
Documentation accurately describes the authentication mechanism:
Files updated:
doc/Learn/Walkthrough/Authentication.Web.howto.mdWebAuthenticationBrokerAPI displays an authentication windowdoc/Learn/Authentication/HowTo-WebAuthentication.mdWebAuthenticationBrokerAPI usageLoginStartUriopens viaWebAuthenticationBroker, not embedded WebViewdoc/Learn/Authentication/AuthenticationOverview.mdTerminology improvements:
Technical accuracy verified against source:
PR Checklist
Screenshots Compare Test Runresults.Other information
No
WebViewUnoFeature is required (correctly documented). OnlyAuthenticationfeature needed.Internal Issue (If applicable):
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.