Skip to content

[docs] Add browser logs documentation covering WithBrowserLogs and BrowserUserDataMode#753

Closed
aspire-repo-bot[bot] wants to merge 2 commits intorelease/13.3from
docs/browser-logs-user-data-mode-1f3a34449e2c9db5
Closed

[docs] Add browser logs documentation covering WithBrowserLogs and BrowserUserDataMode#753
aspire-repo-bot[bot] wants to merge 2 commits intorelease/13.3from
docs/browser-logs-user-data-mode-1f3a34449e2c9db5

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16457 (@davidfowl)

Targeting mainrelease/13.3 does not exist on microsoft/aspire.dev, so falling back to main.

Why this PR is needed

PR microsoft/aspire#16457 added BrowserUserDataMode (a new public enum) and updated WithBrowserLogs with a userDataMode parameter. There is currently no documentation for the WithBrowserLogs feature (first introduced in microsoft/aspire#16310) on aspire.dev. This PR fills that gap.

Key user-facing changes that need documenting:

  • New BrowserUserDataMode enum with Shared (default) and Isolated values
  • Updated WithBrowserLogs(browser, profile, userDataMode) signature
  • Persistent Aspire-managed browser data hives (behavior change from previous per-session temp directories)
  • Browser adoption across AppHost runs in Shared mode
  • Configuration via Aspire:Hosting:BrowserLogs[:{ResourceName}]:UserDataMode

Changes made

New file

  • src/frontend/src/content/docs/app-host/browser-logs.mdx — New page documenting:
    • WithBrowserLogs usage with both C# and TypeScript AppHost examples
    • BrowserUserDataMode.Shared vs BrowserUserDataMode.Isolated behavior
    • Browser selection (msedge, chrome, explicit path)
    • Configuration via appsettings.json
    • Experimental feature notice (suppressing ASPIREBROWSERLOGS001)

Modified file

  • src/frontend/config/sidebar/docs.topics.ts — Added "Browser logs" entry under AppHost > Resource types

Notes for reviewers

  • The feature is still experimental ([Experimental("ASPIREBROWSERLOGS001")]), so the page includes a caution callout.
  • TypeScript examples use camelCase (withBrowserLogs) per the ATS code-generation conventions shown in the PR.
  • The profile + Isolated restriction is documented.
  • Screenshots of the dashboard browser logs resource were not added (would require a running environment).

Note

🔒 Integrity filter blocked 4 items

The following items were blocked because they don't meet the GitHub integrity level.

  • #740 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #667 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #656 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #593 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by PR Documentation Check for issue #16457 · ● 3.9M ·

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Apr 27, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from davidfowl April 27, 2026 05:45
…ataMode

Documents the browser logs AppHost feature introduced in microsoft/aspire#16310
and enhanced with BrowserUserDataMode in microsoft/aspire#16457.

- New page: app-host/browser-logs.mdx
  - Explains WithBrowserLogs and the child browser logs resource
  - Documents Shared vs Isolated BrowserUserDataMode
  - Covers browser selection (msedge, chrome, explicit path)
  - Shows configuration via Aspire:Hosting:BrowserLogs settings
  - Includes both C# and TypeScript AppHost code examples
- Adds sidebar entry under AppHost > Resource types

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist force-pushed the docs/browser-logs-user-data-mode-1f3a34449e2c9db5 branch from 77dc9e6 to 1e1bfa5 Compare April 28, 2026 16:44
@IEvangelist IEvangelist changed the base branch from main to release/13.3 April 28, 2026 16:44
@IEvangelist IEvangelist marked this pull request as ready for review April 29, 2026 20:30
@IEvangelist IEvangelist self-requested a review as a code owner April 29, 2026 20:30
@IEvangelist
Copy link
Copy Markdown
Member

Hey @copilot, I see that we already have a browser-logs.mdx under dev tools/integrations. With that said, we either need to make this one a lot lighter and then point to the other one, de-dup/cleanup, or close this PR.

@davidfowl
Copy link
Copy Markdown
Contributor

Do we just close this?

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

Hey @copilot, I see that we already have a browser-logs.mdx under dev tools/integrations. With that said, we either need to make this one a lot lighter and then point to the other one, de-dup/cleanup,...

The duplicate app-host/browser-logs.mdx and its sidebar entry have been removed (commit adfe8aed). The existing integrations/devtools/browser-logs.mdx in release/13.3 already covers everything comprehensively — BrowserUserDataMode, browser selection, configuration via app settings, the runtime dashboard dialog, and more. This PR is now effectively a no-op and can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants