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

Documentation: Keyboard documentation #1025

Merged
merged 43 commits into from
Jun 19, 2024
Merged

Documentation: Keyboard documentation #1025

merged 43 commits into from
Jun 19, 2024

Conversation

choir241
Copy link
Contributor

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

Copy link

render bot commented Jun 10, 2024

src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 June 10, 2024 18:43
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
---

The Appwrite SDK console is optimized with the keyboard using shortcut keys to enable accessibility. Using shortcut keys access websites without the mouse.

Copy link
Member

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

src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
Copy link
Contributor

@stnguyen90 stnguyen90 left a 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.

src/routes/docs/Sidebar.svelte Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
@stnguyen90 stnguyen90 self-requested a review June 10, 2024 22:16
@choir241 choir241 requested a review from eldadfux June 11, 2024 13:50
…s to be seamlessly integrated into the text, fix sentence structure and improve on word choices and flow of content
Copy link
Member

@eldadfux eldadfux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting closer.

  1. Appwrite console should be consistently Appwrite Console as its the name of the product.

  2. See if you can break the accessibility to 2 paragraph if make sense, its a bit too long for a single paragraph

  3. We avoid using Appwrite users as users, unless very specific and rare cases, refer to them as Appwrite developers or just developers, depends on the context. We use users for users of our developers, more often we call them end-users

  4. 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.

  5. 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/keyboard/+page.markdoc Outdated Show resolved Hide resolved
…what the appwriter is, update icon for sidebar nav, add table for keyboard specs, update wording and sentence structure.
@choir241 choir241 requested a review from eldadfux June 11, 2024 19:23
Copy link
Contributor

@stnguyen90 stnguyen90 left a 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.

src/routes/docs/advanced/platform/+layout.svelte Outdated Show resolved Hide resolved
src/routes/docs/advanced/platform/shortcuts/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/advanced/platform/shortcuts/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/advanced/platform/shortcuts/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/advanced/platform/shortcuts/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/appwriter/+page.markdoc Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 June 19, 2024 14:04
src/routes/docs/tooling/appwriter/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/appwriter/+page.markdoc Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 June 19, 2024 19:33
src/routes/docs/tooling/appwriter/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tooling/appwriter/+page.markdoc Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 June 19, 2024 19:51
@stnguyen90 stnguyen90 merged commit ae5a492 into main Jun 19, 2024
2 checks passed
@stnguyen90 stnguyen90 deleted the docs-keyboard branch June 19, 2024 20:20
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

Successfully merging this pull request may close these issues.

5 participants