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

Combine redundant sections about built-in class reference #10652

Open
tetrapod00 opened this issue Feb 9, 2025 · 0 comments
Open

Combine redundant sections about built-in class reference #10652

tetrapod00 opened this issue Feb 9, 2025 · 0 comments
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation enhancement

Comments

@tetrapod00
Copy link
Contributor

Your Godot version:
4.4
Issue description:

The First look at Godot's interface page ends with the Integrated class reference section. The next page, Learning new features, starts with a section about how to read the manual and class reference, Making the most of this manual.

Additionally there is a third place this is documented How to read the Godot API, in the scripting section.

They each make sense within their respective pages, but it reads kind of strangely and redundantly if you read the whole Getting Started sequence in order. These should maybe be combined in some way. I'd suggest shortening the section in First look, expanding the section in Learning new features, and perhaps linking to How to read the Godot API from one of the two. I think for a first look at an editor, we don't necessarily need to describe extensively how the builtin class reference works.

And the dedicated documentation for what shortcuts are available to access the builtin class reference should not only live in the Getting Started section, since we should treat that as a somewhat optional introductory sequence that you usually shouldn't be going back to for reference, IMO.

Perhaps we should write or expand a section that exists somewhere in the Manual rather than the Getting Started section on how the builtin class reference works.

URL to the documentation page (if already existing):

https://docs.godotengine.org/en/latest/getting_started/introduction/first_look_at_the_editor.html#integrated-class-reference
https://docs.godotengine.org/en/latest/getting_started/introduction/learning_new_features.html#making-the-most-of-this-manual

@tetrapod00 tetrapod00 added area:getting started Issues and PRs related to the Getting Started section of the documentation enhancement labels Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation enhancement
Projects
None yet
Development

No branches or pull requests

1 participant