diff --git a/src/redirects.json b/src/redirects.json index da4407e7f9..91e00c53eb 100644 --- a/src/redirects.json +++ b/src/redirects.json @@ -659,6 +659,10 @@ "link": "/docs/installation", "redirect": "/docs/advanced/self-hosting" }, + { + "link": "/keyboard", + "redirect": "/docs/tooling/keyboard" + }, { "link": "/careers", "redirect": "https://appwrite.careers" diff --git a/src/routes/docs/Sidebar.svelte b/src/routes/docs/Sidebar.svelte index 216ba1a478..b6a4ac6dc8 100644 --- a/src/routes/docs/Sidebar.svelte +++ b/src/routes/docs/Sidebar.svelte @@ -111,6 +111,11 @@ label: 'Assistant', href: '/docs/tooling/assistant', icon: 'icon-sparkles' + }, + { + label: 'Keyboard', + href: '/docs/tooling/keyboard', + icon: 'icon-sparkles' } ] }, diff --git a/src/routes/docs/tooling/keyboard/+layout.svelte b/src/routes/docs/tooling/keyboard/+layout.svelte new file mode 100644 index 0000000000..93e22c8ceb --- /dev/null +++ b/src/routes/docs/tooling/keyboard/+layout.svelte @@ -0,0 +1,9 @@ + + + + + + diff --git a/src/routes/docs/tooling/keyboard/+page.markdoc b/src/routes/docs/tooling/keyboard/+page.markdoc new file mode 100644 index 0000000000..31089f6cd8 --- /dev/null +++ b/src/routes/docs/tooling/keyboard/+page.markdoc @@ -0,0 +1,41 @@ +--- +layout: article +title: Keyboard +description: Appwrite's approach to keyboard accessibility, how to use the keyboard, and how to use the Appwriter. +--- + +The Appwrite SDK console is optimized with the keyboard using shortcut keys to enable accessibility. Using shortcut keys access websites without the mouse. + +|Keys|Action| +|---|---| +|`Ctrl` + `K` or `⌘` + `K`| access command center| +|`ENTER`|execute command center command| +|`Up Arrow`|scroll up the page| +|`Down Arrow`|scroll down the page| + +# 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. + +|Shortcut|Action| +|----|----| +|Go to Auth|`G` then `A`| +|Go to Storage|`G` then `S`| +|Go to Databases|`G` then `D`| +|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 + +{% only_dark %} +![Using Appwrite Assistant's AI features](/images/docs/keyboard/dark/appwriter.png) +{% /only_dark %} + +{% only_light %} +![Using Appwrite Assistant's AI features](/images/docs/keyboard/appwriter.png) +{% /only_light %} + +The resource/product/service/page for shortcuts use the visual icons in Appwrite's website and SDK console. For example, the shortcut for going to databases is `G` then `D`, and the icon on the keyboard matches the icon in Appwrite Databases. \ No newline at end of file diff --git a/static/images/docs/keyboard/appwriter.png b/static/images/docs/keyboard/appwriter.png new file mode 100644 index 0000000000..cdf83ea587 Binary files /dev/null and b/static/images/docs/keyboard/appwriter.png differ diff --git a/static/images/docs/keyboard/dark/appwriter.png b/static/images/docs/keyboard/dark/appwriter.png new file mode 100644 index 0000000000..1481ee42f2 Binary files /dev/null and b/static/images/docs/keyboard/dark/appwriter.png differ