-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
vgezer
wants to merge
6
commits into
godotengine:master
Choose a base branch
from
vgezer:editorintro
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Interface manual basics #9632
+1,260
−133
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
AThousandShips
added
enhancement
area:manual
Issues and PRs related to the Manual/Tutorials section of the documentation
labels
Jul 21, 2024
AThousandShips
requested changes
Jul 22, 2024
There was a problem hiding this 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
vgezer
force-pushed
the
editorintro
branch
3 times, most recently
from
August 4, 2024 19:08
e278a05
to
d318036
Compare
vgezer
force-pushed
the
editorintro
branch
3 times, most recently
from
August 13, 2024 16:05
39dc595
to
90af831
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
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:
No usage of the menus, toolbars etc. I have currently the following items, still WIP:
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.