Added a guide for using Sentry with WinUI 3 #8557
Conversation
|
@jamescrosswell is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
@lucas-zimerman knows about UWP maybe he can help review here
| title: WinUI 3 | ||
| description: "Learn about using Sentry's .NET SDK with the Windows UI Library (WinUI 3)" | ||
| redirect_from: | ||
| - /platforms/dotnet/winui3/ |
There was a problem hiding this comment.
How does it differ from UWP?
Their docs say:
The Windows UI Library (WinUI) is a native user experience (UX) framework for both Windows desktop and UWP applications.
So maybe different. But below says WinUI2 as UWP and WinUI3 can be UWP or "desktop". I'm super confused with this stuff
https://docs.sentry.io/platforms/dotnet/guides/uwp/
| - /platforms/dotnet/winui3/ | |
| - /platform/dotnet/guides/uwp/ |
There was a problem hiding this comment.
From the reading I've done, you can build UWP apps with WinUI 2.7 and under. WinUI 3 is for Windows App SDK apps only (not UWP). So yeah, a bit confusing but I don't think that's confusion Sentry adds (it's just a right of passage for Windows app developers). This Stack Overflow answer gives a fairly concise explanation.
We could remove the 3 in our WinUI 3 title... I haven't tried to create WinUI apps using anything other than WinUI3 though. @lucas-zimerman any thoughts?
The main difference in our guidance between UWP and WinUI 3 is that in UWP there's a Suspending event handler that you can/must wire up. This doesn't seem to exist in WinUI3.
| @@ -0,0 +1,133 @@ | |||
| --- | |||
| title: WinUI 3 | |||
There was a problem hiding this comment.
I'd also recommend dropping the version from the title.
Just mention WinUI 3 below if needed, if we don't support WinUI2 (I believe we do, and we call that UWP), we might want to have 2 sections in the doc for v2 and v3
There was a problem hiding this comment.
Yeah I think WinUI 2 is UWP (which has it's own documentation). You reckon we could/should merge these? At the moment there are two different sets of guidance in this page (JIT and AOT)... I guess if we merge it with UWP then there would be 3 sets of guidance in the one page. I think it might be easier to leave the UWP instructions separate, personally.
There was a problem hiding this comment.
merge and redirect yeah, that'd be best I think.
I suggested the redirect above already.
The instructions could be separate but under headings in the main WinUI doc? Specially since UWP is being replaced. To simplify our docs.
But no strong feelings here, I see there are trade offs
There was a problem hiding this comment.
I don't have strong feelings about this either. It seems clear as-is to me, but I see bruno's argument.
|
Thanks James! |
Pre-merge checklist
If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.
Description of changes
Added a guide for using Sentry with WinUI 3 applications. In particular, the guide contains a section for users who would like to publish their applications using Ahead-of-Time compilation or Trimming enabled, as there are some additional steps that we can't automate using our integration once AOT is enabled.
See: