Description
Describe the project you are working on
I'm a high school teacher teaching game development in godot.
Describe the problem or limitation you are having in your project
Often times, my students will want to understand a function better so they go to the online godot docs and type in the name of the function. For example, str. The search results say nothing about the String str function. Instead there are a lot of results for AudioStreamPlayback and other words that have a str as a substring.
The end result is they do not find information about the function they are searching for.
Describe the feature / enhancement and how it helps to overcome the problem or limitation
Currently the online docs are just doing a substring search. of all the documentation pages.
For the use case of looking up a function name, the built-in "Search Help" feature works perfectly.
The "Search Help" feature in the engine should also be integrated into the online docs. That way if there is direct documentation it can show a link to that.
Additionally, the current substring search seems to not prioritize exact matches or page title matches over substring, in-document matches. I think this would also be a huge benefit to the usability of the online docs.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
Clicking on the first result here str() would link to https://docs.godotengine.org/en/4.3/classes/[email protected]#class-globalscope-method-str
If this enhancement will not be used often, can it be worked around with a few lines of script?
No this is a modification to how to docs website works.
Is there a reason why this should be core and not an add-on in the asset library?
It's not a modification to the engine