[Draft] Add glossary of common terms #10159
Draft
+104
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a glossary of common terms to the online manual.
Uses the sphinx glossary directive.
On its own, this is perhaps a solution in search of a problem. But it's also relatively low-risk and low-cost to add, since it links to other pages, but no other pages depend on it.
With the addition of links to the glossary, this could be a much more useful improvement. We can link to these terms with the term role. Alternately, we can also integrate hoverxref to add tooltips for common terms like acronyms, which link into the glossary.
See also previous discussion in #1650 (comment).
Kinds of terms that will be included in the glossary:
Very common nodes or godot concepts: control, node, viewport, signal, resource
Godot-specific terms: renderer, rendering driver, server (in the Godot sense)
Godot proper nouns: GDScript, GDExtension, Forward+ renderer, Mobile renderer, Compatibility renderer, RenderingDevice
Other proper nouns: Vulkan, Metal, Direct3D 12
Acronyms, including common gamedev/graphics terms: CPU, GPU, DOF, FXAA, MSAA, SSAA, SSAO, SSIL, SDFGI, HDR, SDR, sRGB
The current definitions are roughly representative of the final page in terms of length. Each term should be briefly defined, with 1-3 sentences, and link to a relevant portion of the documentation. However, the current list of terms is not yet complete.
I'm leaving this as a draft to discuss whether this is something worth including at all, and if so, whether there would need to be major changes to implementation.
The page renders like this with the current theme: