various built-in API documentation improvements #6959
azur-wolve
started this conversation in
Editor
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The new built-in documentation on Godot 4 is great.
Though there's still room for improvements.
..have definitions of common terms (computer science, computer graphics, math, physics, etc) packed inside those terms whose would be marked with a doted underlining, and show such definitions on mouse hovering:
This would allow to have cleaner and shorter descriptions. [
Ctrl + Click
to jump to their page definition, see below]a section with all the listed terms (mentioned above) for completeness.
notes (for specific cases) represented either by exponented
a section with all the keywords (things like
var
,await
,..) and literals, with their definitions...and GDScript specification (could be less complete than the one in the official web docs)
hovering pop-ups for preliminary descriptions (similar to wikipedia, pretty sure this one has been proposed previously):
ability to search [
F1
search help] by topic / aspect, aside from only inheritance.add enums to search filter (instead of pack them with constants)
(Some may be considered as unnecessary for the sack of simplicity.)
Feel free to share ideas and QoL improvements, and links to previous discussions of that topic.
Beta Was this translation helpful? Give feedback.
All reactions