Skip to content

Commit

Permalink
add right side navigation for keyboard docs
Browse files Browse the repository at this point in the history
  • Loading branch information
choir241 committed Jun 10, 2024
1 parent d1eb38a commit e8dce55
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -679,4 +679,4 @@
"link": "/cli/install.sh",
"redirect": "https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/install.sh"
}
]
]
2 changes: 1 addition & 1 deletion src/routes/docs/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,4 @@
];
</script>

<Sidebar {navigation} />
<Sidebar {navigation} />
2 changes: 1 addition & 1 deletion src/routes/docs/tooling/keyboard/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
<Docs variant="two-side-navs">
<Sidebar />
<slot />
</Docs>
</Docs>
12 changes: 6 additions & 6 deletions src/routes/docs/tooling/keyboard/+page.markdoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
layout: article
title: Keyboard
description: Learn to efficiently and effectively navigate and access the Appwrite Console with your keyboard or the Appwriter that is embedded with shortcuts.
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 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.

# Accessibility
# Accessibility {% #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
# Shortcuts {% #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
## Global shortcuts {% #global-shortcuts %}
|Shortcut|Action|
|----|----|
|Go to Settings|`G` then `E`|
Expand All @@ -27,7 +27,7 @@ Only in the Appwrite SDK console use these keyboard shortcuts to access Appwrite
|Create Organization|`C` then `O`|
|Ask the AI|`A` then `I`|

## Project shortcuts
## Project shortcuts {% #project-shortcuts %}

|Shortcut|Action|
|----|----|
Expand All @@ -39,7 +39,7 @@ Only in the Appwrite SDK console use these keyboard shortcuts to access Appwrite
|Go to Overview|`G` then `O`|
|Go to Messaging|`G` then `M`|

# The Appwriter
# The Appwriter {% #the-appwriter %}

{% only_dark %}
![The Appwriter](/images/docs/keyboard/dark/appwriter.png)
Expand Down

0 comments on commit e8dce55

Please sign in to comment.