Skip to content

Commit

Permalink
doc: seperated table into global and project shortcuts, reword articl…
Browse files Browse the repository at this point in the history
…e description and all content in doc
  • Loading branch information
choir241 committed Jun 10, 2024
1 parent 639c56e commit d1eb38a
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions src/routes/docs/tooling/keyboard/+page.markdoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
---
layout: article
title: Keyboard
description: How to use the keyboard with the optimized Appwrite Console for both efficiency and accessibility, and introducing The Appwriter.
description: Learn to efficiently and effectively navigate and access the Appwrite Console with your keyboard or the Appwriter that is embedded with shortcuts.
---

The Appwrite SDK console is optimized with the keyboard using shortcut keys to enable accessibility. Using shortcut keys access websites without the mouse.
The Appwrite Console is optimized with the keyboard using shortcut keys to enable accessibility, significantly enhancing the developer's efficiency without the interruption of having to use your mouse. This also benefits developers who rely solely on using keyboards, where their productiveness benefits from the keyboard's ease of use, quick and seamless execution of important actions, and the consistent nature of the keyboard shortcut keys.

|Keys|Action|
|---|---|
|`Ctrl` + `K` or `⌘` + `K`| access command center|
|`ENTER`|execute command center command|
# Accessibility

We are committed to making our platform accessible to all developers by following the AA standards of the [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels).
Following these standards ensures our platform is usable by people with disabilities like visual, auditory, physical, speech, cognitive, language, learning, and neurological.
Having good contrast between text and backgrounds, resizable text without loss of content or functionality, and navigable interfaces via keyboard and screen readers guarantees the creation of an inclusive environment and allows users to perform their tasks efficiently.
We ensure that our dashboard not only complies with legal requirements but also promotes a positive developer experience for everyone by adhering to these guidelines.

# Shortcuts

Only in the Appwrite SDK console use these keyboard shortcuts to access Appwrite's SDK console. Using the first letter from the call to action and the resource/product/service/page, Appwrite's keyboard shortcuts follow this pattern. For example, the shortcut `G` then `S` goes to storage, but if you want to go to settings, the shortcut is `G` then `E` because `G` then `S` is already taken, so the next letter of settings is used.

## Global shortcuts
|Shortcut|Action|
|----|----|
|Go to Settings|`G` then `E`|
|Set theme to light|`T` then `L`|
|Set theme to dark|`T` then `D`|
|Set theme to dark|`T` then `A`|
|Create Organization|`C` then `O`|
|Ask the AI|`A` then `I`|

## Project shortcuts

|Shortcut|Action|
|----|----|
|Go to Auth|`G` then `A`|
Expand All @@ -23,7 +37,6 @@ Only in the Appwrite SDK console use these keyboard shortcuts to access Appwrite
|Go to Functions|`G` then `F`|
|Go to Projects|`G` then `P`|
|Go to Overview|`G` then `O`|
|Go to Settings|`G` then `E`|
|Go to Messaging|`G` then `M`|

# The Appwriter
Expand All @@ -36,4 +49,4 @@ Only in the Appwrite SDK console use these keyboard shortcuts to access Appwrite
![The Appwriter](/images/docs/keyboard/appwriter.png)
{% /only_light %}

In the Appwriter, Appwrite icons are used from the Appwrite Console and Appwrite's Docs to make it easier to memorize Appwrite keyboard shortcuts. For example, the shortcut for going to databases is `G` then `D`, and the icon on the keyboard matches the icon in Appwrite Databases.
Initially, The Appwriter was created for promotional purposes for a Hacktoberfest; however seeing how the community liked it, we continue to think about what we want to do next with the Appwriter. In the Appwriter, Appwrite icons are used from the Appwrite Console and Appwrite's Docs to make it easier to memorize Appwrite keyboard shortcuts. For example, the shortcut for going to databases is G then D, and the icon on the keyboard matches the icon in Appwrite Databases.

0 comments on commit d1eb38a

Please sign in to comment.