Update Debug Information Files Documentation

[tsekiguchi]

Currently, there's a lot of in depth documentation about uploading our own debug files. However, as mentioned over in sentry-cli, this issue has been mostly resolved by adding electron to the debug frameworks.

This is a great solution - however, this is not mentioned anywhere in the current Electron docs, which led me on a long quest to find and unsuccessfully upload dSYM files to Sentry.

For future users, can we please update the documentation to include information about this very important option?

And even better, is there a way to have this auto-enabled for all electron projects? :)

[timfish]

At the docs here: https://docs.sentry.io/platforms/javascript/guides/electron/#debug-information

It says:

Debug Information

To get symbolicated stack traces for native crashes, you should enable fetching debug symbols from the Electron symbol server. Go to Project Settings > Debug Files and add Electron to the list of built-in repositories.

If your app uses a custom Electron fork, contains modules with native extensions or spawns subprocesses, you should upload those symbols manually using the Sentry CLI. For more information, see Native Usage.

Which part of the docs did you land on that we could add a link to this?

[tsekiguchi]

Ah, I didn't see it there! Apologies on my end for missing that.

I was looking in this section here: https://docs.sentry.io/platforms/javascript/guides/electron/data-management/debug-files/

When I searched for 'debug' in the docs, this section was pulled up, and actually I don't see the section you're linking to anywhere in the top results.

Also, in the section you referenced, I don't want to be too elementary, but it helped to have the screenshot to help give some extra emphasis to it. It would be easy to miss as it is. :)

[andreiborza]

@tsekiguchi that's indeed pretty hard to find. This is probably related to https://github.com/getsentry/sentry-docs/issues/11699, we're aware of it and we'll be working on that soon.

As for adding a screenshot, I think that's a good idea. Is this something you might want to contribute over at https://github.com/getsentry/sentry-docs? No pressure though, we can certainly take care of that.

[timfish]

I think there might have also been some discussions over whether we can have these debug repositories automatically enabled when users select Electron as a project type.

[tsekiguchi]

Thank you @andreiborza ! I'd be happy to submit a PR for an updated portion of the docs. I'm poking around right now, what the standardized way to add screenshots in the .mdx files?

[andreiborza]

@tsekiguchi cool, thanks!

For images, you can create an img folder relative to the mdx file and use markdown image syntax. For example: https://github.com/getsentry/sentry-docs/blob/1715fe49162cc3b55a2ddafb8f3f251a524afa35/docs/product/codecov/how-it-works.mdx

Let me know if you need any help.