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

Improved source code documentation #9256

Open
JekSun97 opened this issue Apr 19, 2024 · 0 comments
Open

Improved source code documentation #9256

JekSun97 opened this issue Apr 19, 2024 · 0 comments
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement

Comments

@JekSun97
Copy link

JekSun97 commented Apr 19, 2024

Godot 3.5, 4.2.2

Godot needs more detailed documentation on the source code of the engine, everything written here (Engine core and modules) is not enough, I have a decent amount of experience with C++, but I can't figure out which part of the engine is, some definitions are not clear to me, I have something to add to the engine, but the entry threshold is very complex, perhaps some kind of structure is needed that describes where the engine signal goes at a certain moment, during some action, in which file this code is located.

Perhaps we need a completely new section in the documentation describing the source code, this is necessary for programmers who want to contribute to the engine from around the world, as well as for those who write GDExtension extensions. Without knowing the source code I won't be able to write the extension, also this would be a great document for those who come to Godot from other companies like Google etc and need to understand in a short time how the code works.

It is clear that it is unlikely that anyone will describe every function inside the engine, but something needs to be done in this area.

@Calinou Calinou added content:redirect Issues and PRs involving moving content and adding a redirect rule on the backend area:contributing Issues and PRs related to the Contributing/Development section of the documentation and removed content:redirect Issues and PRs involving moving content and adding a redirect rule on the backend labels Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement
Projects
None yet
Development

No branches or pull requests

2 participants