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

Write documentation #85

Closed
limbonaut opened this issue Feb 1, 2025 · 3 comments
Closed

Write documentation #85

limbonaut opened this issue Feb 1, 2025 · 3 comments

Comments

@limbonaut
Copy link
Collaborator

limbonaut commented Feb 1, 2025

We need to get documentation started. Godot also has built-in class documentation - if a user tries to search for our classes in the "Help" browser (also used for IntelliSense and in tooltips). All our public classes conveniently start with "Sentry". This is tracked in #8.

This issue is about Sentry documentation.

Linked PR:

@limbonaut limbonaut added this to GDX Feb 1, 2025
@limbonaut limbonaut moved this to Todo in GDX Feb 1, 2025
@bruno-garcia
Copy link
Member

Some info for docs:

you can tag @vaind @bitsandfoxes and me for review

@bruno-garcia
Copy link
Member

The situation with debug files, and default template and release and debug builds need to be clarifiied extensively on the docs.
Including steps on how to compile debugable Godot builds and linking to GitHub issues tracking this.

I expect this will be a pain for users and we'll need to provide builds of Godot that are debugabble that we automatically get the symbols available in Sentry for them to make things very easy to users.

@limbonaut limbonaut moved this from Todo to In Progress in GDX Feb 18, 2025
@bruno-garcia
Copy link
Member

@github-project-automation github-project-automation bot moved this from In Progress to Done in GDX Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants