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

Inconsistent headers in workshop section of the docs. #893

Open
rjulian opened this issue Jan 6, 2024 · 3 comments
Open

Inconsistent headers in workshop section of the docs. #893

rjulian opened this issue Jan 6, 2024 · 3 comments

Comments

@rjulian
Copy link
Contributor

rjulian commented Jan 6, 2024

Not sure if this is a bug or there was some historical reason for this, but the use of hideHeader in the workshop section of the docs creates a poor UX for mobile or for browsers that don't support the shortcuts (I'll try to create a separate issue for this).

I've gone ahead and removed the hideHeader tag and personally, I find the UI to still look good with the headers and having the header functionality makes the workshop MUCH more usable (previously, I'd actually have to refresh the tab to stop the sounds from playing).

Let me know here if there was a reason for the hideHeader and feel free to close my PR. If it looks good to you, I'd appreciate the merge.

@felixroos
Copy link
Collaborator

Thanks for the report and the PR!

Let me know here if there was a reason for the hideHeader and feel free to close my PR. If it looks good to you, I'd appreciate the merge.

I've created this workshop initially for a real world workshop and wanted to make sure people are learning to use the keyboard shortcuts instead of just clicking through the examples.. I think it's better for users with keyboards but of course worse / unusable for mobile. I haven't yet heard of browsers that don't support the shortcuts.

So it is clear that this needs to change but maybe there is a way to detect mobile users and only show them the ui in the workshop? We could also merge the PR now and then work on this, but I wouldn't want to keep the full headers on the workshop for longer because I think it actually makes a difference when people learn the shortcuts from the start

What do you think?

@rjulian
Copy link
Contributor Author

rjulian commented Jan 12, 2024

Hey Felix, thanks for getting back to me.

Totally understand the goal of getting people to learn the keyboard shortcuts and maybe the idea there is to have one or two of the interactive prompts where the must use the shortcuts (if detected on desktop)?

In my setup, I have CTRL+. mapped to another function at the OS level, so I never use the stop hotkey. I'm certain with how browser extensions and hotkeys are, I won't be the only one with this problem on desktop.

Totally, in the future, some thought should be given to mobile UI versus desktop UI. Because the experience on mobile, while totally possible, isn't optimized.

@felixroos
Copy link
Collaborator

#894 is now merged, but let's keep this open to not forget about the further improvements discussed above

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

No branches or pull requests

2 participants