Skip to content

Update events documentation#8435

Open
sameerag wants to merge 5 commits intodevfrom
docs-events-guidance
Open

Update events documentation#8435
sameerag wants to merge 5 commits intodevfrom
docs-events-guidance

Conversation

@sameerag
Copy link
Copy Markdown
Member

@sameerag sameerag commented Mar 17, 2026

Updates the MSAL Browser events documentation to add guidance on appropriate usage of the event system (UI updates vs. application-critical logic/telemetry).

Changes:

Adds a note warning against relying on events for critical application flows or telemetry.A

@sameerag sameerag requested a review from a team as a code owner March 17, 2026 09:34
Copilot AI review requested due to automatic review settings March 17, 2026 09:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the MSAL Browser events documentation to add guidance on appropriate usage of the event system (UI updates vs. application-critical logic/telemetry).

Changes:

  • Adds a note warning against relying on events for critical application flows or telemetry.

shylasummers
shylasummers previously approved these changes Mar 18, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@sameerag
Copy link
Copy Markdown
Member Author

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 18, 2026

@sameerag I've opened a new pull request, #8448, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits March 18, 2026 15:56
The `[!NOTE]` block in `events.md` was missing the required `>`
blockquote markers, causing it to render as plain text on GitHub instead
of a formatted alert block.

## Changes
- `lib/msal-browser/docs/events.md`: Add `>` blockquote prefix to
`[!NOTE]` admonition to match GFM alert syntax used elsewhere in the
repo (e.g., `caching.md`)

**Before:**
```markdown
 [!NOTE]
 Please do not use events for critical flows...
```

**After:**
```markdown
> [!NOTE]
> Please do not use events for critical flows...
```

<!-- START COPILOT CODING AGENT TIPS -->
---

🔒 GitHub Advanced Security automatically protects Copilot coding agent
pull requests. You can protect all pull requests by enabling Advanced
Security for your repositories. [Learn more about Advanced
Security.](https://gh.io/cca-advanced-security)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
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.

4 participants