godot-orchestrator icon indicating copy to clipboard operation
godot-orchestrator copied to clipboard

Clearer explanations in the docs' getting started section

Open kubyon opened this issue 6 months ago • 4 comments

Description

At the moment, the documentation's getting started section directly mirrors that of Godot's. While this has provided a decent baseline for contents, many features/concepts unique to Orchestrator are not properly elaborated upon (e.g the All Actions dialogue box, relationships between graph nodes), making tutorials harder to follow and be understood, particularly for non-programmers. As such, the section could benefit from additional clarity.

Implementation ideas

At the moment, it is recommended that users should review Godot's docs before proceeding to Orchestrator's. While the former has done a good job explaining concepts (especially those of technical nature), it is only relative to GDScript's features, something that Orchestrator does not yet build upon.

As provided in the example below, the note does explain the Call Init event's functions, but does not make it clear why you should use those 2 nodes in particular or why you should be connecting white arrows to each other. image Personally, I think key Orchestrator features could be briefly explained right after being introduced, to make it clearer why they function as such.

The icon rotation tutorial faces a similar problem. It tells you what steps you should take to get this result: image ...But it does not explain why you should use those nodes, nor why are nodes connected as such. An explanation of node relationships could make concepts easier to digest as well. I was only able to understand this after cross-referencing both docs multiple times, which is not very ideal for beginners.

kubyon avatar Jul 29 '24 03:07 kubyon