-
Notifications
You must be signed in to change notification settings - Fork 2.7k
[msal-v5] Update public docs #8141
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
Conversation
|
@copilot update PR description |
|
@hectormmg I've opened a new pull request, #8150, to work on those changes. Once the pull request is ready, I'll request review from you. |
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 updates the MSAL.js documentation to reflect Microsoft's rebranding from Azure AD to Microsoft Entra ID, clarify the deprecation of CDN support, and reorganize version support information to improve developer guidance.
Key Changes:
- Updated all references from "Azure AD" to "Microsoft Entra ID" across README files
- Added comprehensive "Library Version Support Status" table showing current (v5) and LTS versions for all packages
- Reorganized migration guides in reverse chronological order and added CDN deprecation warnings
- Simplified the Authorization Code Flow documentation by removing deprecated Implicit Flow references
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Updated branding to Microsoft Entra ID, added Library Version Support Status table with v5 current versions and LTS details, added CDN deprecation warning, reorganized package structure section, removed roadmap references |
lib/msal-browser/README.md |
Updated branding, added CDN deprecation section with warning, added Yarn installation instructions, reorganized migration guides in reverse chronological order, simplified Authorization Code Flow section by removing Implicit Flow comparisons, updated framework wrapper references |
lib/msal-browser/docs/events.md |
Updated product name capitalization from "Msal-Browser" to "Msal Browser" and "MSAL Browser" for consistency |
lib/msal-browser/docs/performance.md |
Updated example library version from "2.22.2-beta.2" to "5.0.0" to reflect current version |
lib/msal-browser/docs/v2-migration.md |
Replaced CDN documentation reference with expanded deprecation warning including link to Library Version Support Status table |
lib/msal-browser/docs/cdn-usage.md |
Removed extensive CDN usage documentation (SRI hashes, domains, best practices) since CDN is deprecated, kept only minimal migration guidance |
docs/diagrams/png/PackageStructure.png |
Added/updated package structure diagram (binary file) |
tnorling
left a comment
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@hectormmg I've opened a new pull request, #8151, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@hectormmg I've opened a new pull request, #8152, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Addresses feedback on #8141 to clarify migration guide selection for users. ## Changes - Added introductory statement "Select the guide that matches your current MSAL version:" before the migration guides list in `lib/msal-browser/README.md` The statement precedes the reverse-chronological list of migration guides (v4→v5, v3→v4, v2→v3, v1→v2) to help users quickly identify which guide applies to their current version. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hectormmg <5218163+hectormmg@users.noreply.github.com> Co-authored-by: Hector Morales <hemoral@microsoft.com>
Addresses review feedback from PR #8141 to remove a stray backslash character at the end of line 9 in README.md. The backslash (`\`) was a formatting artifact with no semantic purpose that could cause rendering issues in some markdown parsers. **Change:** - Line 9: `README.md.\` → `README.md.` <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/AzureAD/microsoft-authentication-library-for-js/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hectormmg <5218163+hectormmg@users.noreply.github.com> Co-authored-by: Hector Morales <hemoral@microsoft.com>
@peterzenz based on our previous discussion, should we just replace the support table in this doc with the new table in the main README? |
This pull request updates documentation for the Microsoft Authentication Library for JavaScript and its browser package. The main focus is on improving clarity around supported versions, updating branding to "Microsoft Entra ID," and providing guidance on CDN deprecation and migration paths. It also reorganizes and streamlines several sections for easier navigation and understanding.
Branding and terminology updates:
Version support and deprecation guidance:
README.md, clarifying current and LTS versions for all packages and explicitly marking deprecated packages.@azure/msal-browserCDN, advising developers to use package managers instead. [1] [2]Installation and migration instructions:
lib/msal-browser/README.mdto include sections for CDN deprecation, NPM, and Yarn, with direct links to migration guides for all major version upgrades. [1] [2]@azure/msal-browser.Documentation structure and clarity improvements: