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

Improve class reference split, list variant types separately #68831

Merged
merged 1 commit into from
Nov 18, 2022

Conversation

YuriSizov
Copy link
Contributor

@YuriSizov YuriSizov commented Nov 18, 2022

Follow-up to #63497 with a number of improvements based on early feedback.

  • Fixes the issue with subsection references being duplicated.
  • Adds a new main section to serve as a page title, "All classes", which fixes breadcrumbs (always referring to "Globals", no matter which class you were looking at).
  • Splits "Objects" into "Other objects" (since nodes and resources are also objects) and "Variant types", giving the latter their own home in the class reference.
  • Adds "Object", "Node", and "Resource" as a first entry to their own groups, "Other objects", "Nodes", "Resources"; they also still remain in their current groups, based on inheritance (e.g. you can find "Node" in "Other objects").

chrome_2022-11-18_15-46-19

image

PS. I can push a commit with an updated index.rst to the docs repo if this is accepted.

@YuriSizov YuriSizov added this to the 4.0 milestone Nov 18, 2022
@YuriSizov YuriSizov requested a review from a team as a code owner November 18, 2022 12:54
@YuriSizov YuriSizov requested a review from akien-mga November 18, 2022 14:11
YuriSizov added a commit to godotengine/godot-docs that referenced this pull request Nov 18, 2022
@YuriSizov
Copy link
Contributor Author

🎉 Pushed godotengine/godot-docs@3cb7181 since this is approved now.

@akien-mga akien-mga merged commit 1af7e39 into godotengine:master Nov 18, 2022
@YuriSizov YuriSizov deleted the docs-classref-better-split branch November 18, 2022 19:51
@akien-mga
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants