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 naming and organization of some manual articles #6826

Merged

Conversation

YuriSizov
Copy link
Contributor

@YuriSizov YuriSizov commented Feb 26, 2023

This PR includes several changes aimed at improving sidebar navigation or overall organization of the documentation.

  • In "Platforms" HTML5/Web platform pages were moved to their own subfolder, web;
  • In "3D" Global Illumination pages were moved to their own subfolder, global_illumination;
  • "User Interface (UI)" lost its excessive capitalization to become "User interface (UI)";
  • "Input and Output (I/O)" was renamed to "File and data I/O";
  • "Inputs" was renamed to "Input handling";
  • "2D" and "3D" sections had their tutorials grouped to reduce the size of the initial list, give some order, and ultimately improve navigation;
  • Also some no-longer in-use images were dropped.

After these changes the top level of the "Manual" category looks like this.
And here are the 2D and 3D sections:

chrome_2023-02-26_17-13-28
chrome_2023-02-26_17-13-43


All pages which changed their path were added to redirects.

@YuriSizov YuriSizov added enhancement content:organization Issues and PRs related to reorganizing the content area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Feb 26, 2023
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! You can rebase the temporary fix away.

@YuriSizov
Copy link
Contributor Author

YuriSizov commented Feb 26, 2023

You can rebase the temporary fix away.

@akien-mga Wait, but I don't think the CI will pass since the class ref hasn't been synced with this repo yet?

PS. I can do it myself, if you want. Done.

HTML5/Web moved to their own subfolder
Global Illumination moved to their own subfolder
UI, IO, Inputs sections titles adjusted
2D, 3D tutorials grouped to improve navigation
@YuriSizov YuriSizov merged commit 6fae64f into godotengine:master Feb 26, 2023
@YuriSizov YuriSizov deleted the web-improve-naming-navigation branch February 26, 2023 21:53
@YuriSizov
Copy link
Contributor Author

I don't remember how we resolved this before, if at all, but naturally updating class ref first also fails the CI for that particular commit 🙃 Should be good after both changes are merged now.

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 content:organization Issues and PRs related to reorganizing the content enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants