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

Add tutorial steps and tasks for every UI element #67

Open
Inwerpsel opened this issue Apr 13, 2024 · 0 comments
Open

Add tutorial steps and tasks for every UI element #67

Inwerpsel opened this issue Apr 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation performance The issue is a performance issue or has significant performance implications

Comments

@Inwerpsel
Copy link
Owner

Inwerpsel commented Apr 13, 2024

Now that the right primitives for tutorials are added, it should be possible to create a tutorial that guides you through every UI element.

Ideally the tutorial content can also be shown individually with an info button in the UI. Perhaps a general info toggle, similar to the "drag enabled" toggle, could allow getting info without putting tons of little buttons everywhere.

Challenges

Complex tutorial state

In order to properly demonstrate the purpose of certain elements, a fairly long sequence of other actions will have to be done and captured. Examples of this are history locking, the history stash, the palette. For these elements, actually putting the user in the intended situation should make it much easier to understand than trying to explain in words only.

This is especially the case for the history stash, which cannot easily be tied to interactions most users are familiar with. If the tutorial recreates the situation where you lose a lot of changes by doing an edit when navigating far back in history, the explanation can be given afterwards and will be much easier to digest.

Incomplete implementations

Some elements are incomplete or even partially broken, which makes explaining them perhaps more work than just improving them first.

Performance

If most UI elements will include a tutorial element, it will be crucial to keep an eye on how it affects performance. Especially since many of these new ones have multiple instances on the screen at the same time.

Elements

Roughly ordered

Stable:

  • VariableControl
  • Rules and element locators
  • Set raw value: colors, spacing, others
  • Link
  • Unset
  • Linked variable
  • Annoying prefix
  • Add alias
  • History lock
  • History stash

Might wanna change first:

  • ScopeControl: properly exclude locator on root elements, should indicate which parent element gives the scope (sometimes this element has no matches so inspection would need to somehow include it, could be done by simply including the whole tree, or maybe this becomes really easy when frame interaction happens synchronously)
  • References: list style is too terrible
  • History "do again": might change the behavior so that the button applies the state at the end of the timeline when visiting this history entry
@Inwerpsel Inwerpsel added documentation Improvements or additions to documentation performance The issue is a performance issue or has significant performance implications labels Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation performance The issue is a performance issue or has significant performance implications
Projects
None yet
Development

No branches or pull requests

1 participant