Skip to content

Add comprehensive guides for Sendama editor usage#23

Merged
amasiye merged 1 commit into
mainfrom
develop
Mar 12, 2026
Merged

Add comprehensive guides for Sendama editor usage#23
amasiye merged 1 commit into
mainfrom
develop

Conversation

@amasiye

@amasiye amasiye commented Mar 12, 2026

Copy link
Copy Markdown
Contributor

This pull request introduces a comprehensive set of documentation improvements for the Sendama editor, focusing on clarifying workflows, detailing panel-specific controls, and providing a new modular guide set for task-oriented learning. The changes make it easier for users to understand how the editor works, what gets saved and when, and how to use its features effectively. The documentation now includes step-by-step guides, expanded explanations of panel behaviors, and clearer descriptions of asset and component workflows.

New Guides and Documentation Structure

  • Added a modular guide set under docs/guides/README.md, including step-by-step guides for getting started, building scenes, working with assets, and using the Inspector. This makes the documentation more accessible and task-oriented. [1] [2] [3]
  • Linked the new guide set from both README.md and docs/Editor.md, so users can easily find the guides. [1] [2]

Editor Startup and Project Normalization

  • Clarified project structure requirements and described the startup sanity check, which offers to normalize missing folders or files. This helps new users set up projects correctly and understand the normalization prompt. [1] [2]

Panel and Workflow Details

  • Expanded descriptions of panel-specific workflows, including how Shift+A behaves differently in each panel (Hierarchy, Assets, Inspector), and detailed the asset creation and add-component workflows. [1] [2] [3] [4] [5] [6]
  • Added explanations of component addition, removal, and reordering in the Inspector, including hotkeys and modal behaviors. [1] [2] [3]

Scene and Asset Handling

  • Clarified asset root compatibility with both Assets and legacy assets folders, and improved descriptions of how scene and asset references are resolved. [1] [2] [3]
  • Explained file asset renaming behavior, including updating scene references and rewriting PHP class declarations for script assets.

Saving and Persistence

  • Provided clearer explanations of what gets saved and when, emphasizing the distinction between scene edits (saved on Ctrl+S) and immediate asset changes. [1] [2] [3]

These improvements collectively make the editor documentation much more user-friendly and actionable, especially for new users or those learning specific workflows.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@amasiye amasiye merged commit 4ef26a0 into main Mar 12, 2026
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant