Improve GDScript Basics sidebar navigation by changing header levels #10080
+42
−52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Promotes many headers up one level, so they appear in the sidebar. Removes the redundant Language header, since the whole page is about the language.
tetrapod00
force-pushed
the
gdscript-sidebar
branch
from
cf3910c
to
4a24e75
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #5701. IMO fixing the sidebar navigation will sufficiently fix the problem mentioned in that issue, although the OP is asking for a slightly different solution.
Promotes many headers up one level, so they appear in the sidebar. Removes the redundant Language header, since the whole page is about the language.
Each separate topic is promoted to a top-level subheader on this page, so it appears in the sidebar. The sidebar is long, but still fits on a single screen on a 1080 monitor. Ideally I would have liked to have two levels of navigable headers, but this is the best we can do with the current Sphinx theme. Subheaders under each promoted header are also promoted one level.
The Language and Data headers were removed. In the current organization, it was a parent header for Identifiers, Keywords, Operators, and a few others. However, this whole page is technically a description of the language, and because all the other headers were promoted to top-level, keeping the Language header seemed redundant to me. The Data header was similarly meant to have Variables, Constants, etc as subheaders, but if those subheaders are promoted it is now just an empty sibling header, and is redundant. I don't strongly care about this change; these two headers can be added back if anyone feels strongly.