Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve debug symbol docs #136

Open
bruno-garcia opened this issue Mar 8, 2025 · 0 comments
Open

Improve debug symbol docs #136

bruno-garcia opened this issue Mar 8, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@bruno-garcia
Copy link
Member

bruno-garcia commented Mar 8, 2025

We have great instructions on how to compile Godot from source, and upload symbols to Sentry done through:

It's live on: https://docs.sentry.io/platforms/godot/configuration/stack-traces/

Some thoughts on how we can improve:

  1. The final screenshot indicates something is off:

Image

That red icon, when hovering says:

Image

I do see funtion names, line number and file paths though so I'm not sure why the UI is showing an error. But we should investigate as it could be the way the debug files were generated (e.g: No Call Frame Information (CFI))) or a bug in Sentry, for example.

  1. Linking to /platform/native.
    Ideally we don't navigate away from the selected platform. So if the concern is that docs will go out of sync because of all the copy paste. We should create an include. All content goes to a single file, and we include everywhere. That native symbol stuff is used in several docs, like Android, Unreal, .NET etc.
@bruno-garcia bruno-garcia added the documentation Improvements or additions to documentation label Mar 8, 2025
@bruno-garcia bruno-garcia moved this to Todo in GDX Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant