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

[Draft] Add glossary of common terms #10159

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tetrapod00
Copy link
Contributor

@tetrapod00 tetrapod00 commented Oct 29, 2024

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:
msedge_R4lc0e487K

@tetrapod00 tetrapod00 marked this pull request as draft October 29, 2024 02:36
@Piralein Piralein added enhancement content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.3 labels Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.3 content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants