-
Notifications
You must be signed in to change notification settings - Fork 203
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
Documentation: Keyboard documentation #1025
Conversation
… for keyboard QR code
Your Render PR Server URL is https://appwrite-io-docker-pr-1025.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cpjjqdicn0vc738ipbpg. |
…e rows from accessibility table
--- | ||
|
||
The Appwrite SDK console is optimized with the keyboard using shortcut keys to enable accessibility. Using shortcut keys access websites without the mouse. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be a good idea to title this Windows vs Linux vs macOS
explain the differences and then share the table. Or we can even drop the table as I don't see much value in the Enter
key description, our audience should be familiar with basics
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure to see Eldad's comments.
…e description and all content in doc
… appwriter content
…s to be seamlessly integrated into the text, fix sentence structure and improve on word choices and flow of content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Getting closer.
-
Appwrite console
should be consistentlyAppwrite Console
as its the name of the product. -
See if you can break the accessibility to 2 paragraph if make sense, its a bit too long for a single paragraph
-
We avoid using
Appwrite users
as users, unless very specific and rare cases, refer to them asAppwrite developers
or just developers, depends on the context. We use users for users of our developers, more often we call them end-users -
Something here doesn't work, we can rephrase it
The Appwrite Console is optimized with the keyboard using shortcut keys, significantly enhancing the developer's efficiency without interruption from using the mouse.
The console is not optimized with the keyboard its optimized for using with a keyboard. -
This sentence doesn't make sense, also avoid explaining a concept by using a concept.
Only in the Appwrite console can you use these keyboard shortcuts to access Appwrite's console
|
||
# Shortcuts {% #shortcuts %} | ||
|
||
Only in the Appwrite console can you use these keyboard shortcuts to access Appwrite's console. Appwrite's keyboard shortcuts follow the following pattern: use the first letters from the call to action and the resource, product, service, or page. For example, using the shortcut `G,` then `S` goes to storage, but the shortcut `G` then `E` is if you want to go to settings, because `G` then `S` is already taken, so the following letter of settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only in the Appwrite console can you use these keyboard shortcuts to access Appwrite's console. Appwrite's keyboard shortcuts follow the following pattern: use the first letters from the call to action and the resource, product, service, or page. For example, using the shortcut `G,` then `S` goes to storage, but the shortcut `G` then `E` is if you want to go to settings, because `G` then `S` is already taken, so the following letter of settings. | |
Only in the Appwrite console can you use these keyboard shortcuts to access Appwrite's console. Appwrite's keyboard shortcuts follow the following pattern: use the first letters from the call to action and the resource, product, service, or page you're targeting. For example, using the shortcut `G,` then `S` goes to storage, but the shortcut `G` then `E` is if you want to go to settings, because `G` then `S` is already taken, so the following letter of settings will be used for this shortcut. This pattern is used to make usage of shortcuts consistent and predictable. |
…what the appwriter is, update icon for sidebar nav, add table for keyboard specs, update wording and sentence structure.
…tructure/flow of sentences
Co-authored-by: Christy Jacob <[email protected]>
Co-authored-by: Christy Jacob <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some additional comments. Besides that, there are some previous comments that were not addressed yet. Please make sure to review them all, including the hidden ones.
Co-authored-by: Steven Nguyen <[email protected]>
Co-authored-by: Steven Nguyen <[email protected]>
…olumn and action to second column for keyboard shortcut tables, add heading for appwriter backlight
…nto docs-keyboard
What does this PR do?
Adds Keyboard documentation to docs
Adds appropriate URL link for Keyboard QR code
Test Plan
x
Related PRs and Issues
x
Have you read the Contributing Guidelines on issues?
Yes