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

Interface manual basics #9632

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Conversation

vgezer
Copy link
Contributor

@vgezer vgezer commented Jul 21, 2024

This is an initiative to have a detailed manual on editor's interface elements. Which menu does what, where to find a specific tool, etc.

Currently, some useful functionality is discovered by accident. By looking at the merged PRs of such items (e.g., menu items or toolbar buttons) as well as the source code, I am trying to document the usage of each interface element in different sections.

Currently on this page we on this page: https://docs.godotengine.org/en/stable/tutorials/editor/index.html, we have:

Using the Project Manager
The Inspector
Project Settings
Default editor shortcuts
Customizing the interface

No usage of the menus, toolbars etc. I have currently the following items, still WIP:

Editor's Interface:

  • Project Manager
  • Editor's Interface

Interface Elements:

  • Main menus

  • Workspace selector

  • Playtest buttons and renderer

  • Scene switcher

  • Bottom panel

    Default panels, from scratch, or reference to existing pages

  • Docks:

  • Scene Dock (separate commit)

  • Import

  • FileSystem

  • Inspector

  • Node

  • History

Each dock on its own page, either new page, or reference to existing pages.

Customization:

I think it makes sense to have an overview of all interfaces, elements including (basic) usage.

PS: There are also tools to be documented, such as Orphan Resource Explorer, Docks themselves, or some optimization topics such as Customize run instance, but I think this should be the starting point.

@AThousandShips AThousandShips added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jul 21, 2024
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

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

Some initial feedback, needs some extensive work for grammar and wording and will go over again when I find the time

tutorials/editor/project_settings.rst Show resolved Hide resolved
tutorials/editor/main_menus.rst Show resolved Hide resolved
tutorials/editor/bottom_panel.rst Show resolved Hide resolved
tutorials/editor/bottom_panel.rst Show resolved Hide resolved
tutorials/editor/bottom_panel.rst Show resolved Hide resolved
tutorials/editor/bottom_panel.rst Show resolved Hide resolved
tutorials/editor/bottom_panel.rst Show resolved Hide resolved
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 enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants