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

Expand and reformat "Commands and Shortcuts" section in "Workflow Editor" article #120

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

banchan86
Copy link
Contributor

@banchan86 banchan86 commented Jan 30, 2025

Fixes #108. This PR expands and reformats the "Commands and Shortcuts" for improved readability. At the same time it adds some commonly used shortcuts that are missing. The list of changes:

  • Rename commands to actions
    • For a visual language, actions might make more sense than commands
  • Adopt pipe table
    • More established pattern for finding actions and keyboard shortcuts
    • Uses less space, especially if we want to add more shortcuts
  • Shorten actions names
    • Uses imperative style (link instead of linking)
    • Drops articles (maybe a bit controversial but I feel including them is unnecessarily wordy)
  • Split point-and-click actions from keyboard shortcuts
    • Easier to distinguish between them
    • A bit unsure about where to put keyboard modifiers that affect point-and-click actions, but for now I have opted to group them together with the Point-and-Click column
  • Shorten and simplify sentences
    • I have kept most of the verbiage in the Point-and-Click column (maybe necessary for novices)
    • Reduced wording in the Keyboard Shortcuts column (fits established patterns, not necessary for more experienced people)
  • Format content for consistency
    • Some of the actions make explicit reference to a panel while others did not, I have added a panel item to all
  • Add some missing shortcuts

Online preview

@banchan86
Copy link
Contributor Author

@RoboDoig requested you as a reviewer because I hear you're really fast at live demos 😄 Could you check if I missed any keyboard shortcuts or if you'd like to tweak the list?

@banchan86 banchan86 added the documentation Improvements or additions to documentation label Jan 31, 2025
@glopesdev
Copy link
Member

glopesdev commented Feb 2, 2025

@banchan86 This is definitely needed, thanks! I will review more carefully, but one thing that jumps to mind is having the keyboard shortcuts column to the side might make it simultaneously more confusing and less visible.

I wonder if we should just have one of these tab interfaces where people can pick which modality they want to consult (keyboard or mouse) and have a separate table for each? This might also make it possible to solve more cleanly your issue with key modifiers in the mouse interface.

Otherwise we can do like VS code and keep all the shortcuts in a handy PDF cheat sheet: keyboard-shortcuts-windows.pdf

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revise and update keyboard shortcuts section in 'Workflow Editor' article
2 participants