docs: BugSplat for .NET Framework guide + .NET Framework sample pages - #343
Merged
Merged
Conversation
Rewrites the .NET Framework integration guide for the new BugSplatDotNet SDK (.NET Framework 4.7.2+, x64), replacing the retired BugSplat.CrashReporter / BsSndRpt.exe instructions: SDK layout, setup, reporting handled exceptions with Post from the catch, symbol upload, WER registration, limitations, native apps that host .NET, an API reference, and an upgrade table from the legacy SDK. Adds sample pages for MyDotNetFrameworkWpfCrasher and MyDotNetFrameworkHostCrasher, lists them in SUMMARY.md and the samples index, and updates the full-memory-dump and crash-dialog pages that still described the legacy SDK. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Unresolved documentation issues include missing native prerequisites and code examples with namespace or API inconsistencies.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Documents the new BugSplat .NET Framework SDK and adds WPF and C++-hosted sample guidance.
Changes:
- Rewrites the .NET Framework integration and migration guide.
- Adds WPF and hosted .NET Framework sample documentation.
- Updates full-memory dump and crash-dialog branding guidance.
| File | Description |
|---|---|
SUMMARY.md |
Adds the new samples and integration guide. |
introduction/getting-started/posting-a-test-crash/README.md |
Lists the new sample applications. |
introduction/getting-started/posting-a-test-crash/mydotnetframeworkwpfcrasher/README.md |
Documents WPF sample workflows. |
introduction/getting-started/posting-a-test-crash/mydotnetframeworkhostcrasher/README.md |
Documents C++ hosting scenarios. |
introduction/getting-started/integrations/desktop/windows-dot-net-framework.md |
Provides the new SDK integration and API guide. |
introduction/getting-started/integrations/desktop/cplusplus/full-memory-dumps.md |
Updates the .NET full-dump example. |
education/how-tos/customize-the-crash-dialog.md |
Clarifies native and .NET branding assets. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
BugSplat.dll, BugSplatMonitor.exe and BugSplatWer.dll depend on the x64 Visual C++ 2015-2022 runtime, which neither Windows nor the .NET Framework includes. Document chaining vc_redist.x64.exe or app-local copies, as the C++ guide does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
daveplunkett
approved these changes
Sep 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
BugSplatDotNetSDK for .NET Framework 4.7.2+ (BugSplat-Git/bugsplat-windows#187), which replaces the retiredBugSplat.CrashReporter/BsSndRpt.exeSDK that the live .NET Framework page still describes. The download link (item=dotnet) stays the same; it will serve the new SDK once it's released.Rewritten: Integrations › Desktop › BugSplat for .NET Framework
BugSplat\dotnet\...\net472, the x64 native runtime,Samples).BugSplatonce, report handled exceptions withPostfrom inside thecatch, upload symbols, and test.SetCrashType(8)).New sample pages (Platform Samples)
Both are listed in
SUMMARY.mdand the samples index.Other pages
MiniDumpTypeAPI instead ofCrashReporter.BugSplatRcproject ships in the native SDK; the .NET download includes only the builtBugSplatRc.dll.Relationship to #340
#340 documents the modern .NET (
net10.0) SDK and its samples, which aren't part of this release (bugsplat-windows#194 holds that packaging). It still describes the managed-post API that was removed before release, so it needs updating before the .NET 10 release; this PR doesn't depend on it.🤖 Generated with Claude Code