Skip to content

Commit

Permalink
doc create and add content to keyboard-documentation, change redirect…
Browse files Browse the repository at this point in the history
… for keyboard QR code
  • Loading branch information
choir241 committed Jun 10, 2024
1 parent df8700d commit 3815f36
Show file tree
Hide file tree
Showing 11 changed files with 68 additions and 9 deletions.
4 changes: 2 additions & 2 deletions src/partials/auth-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,6 @@
---

- `users.*.verification.*.update`
- This event triggers when a verification token for a user is validated.
Returns [Token Object](/docs/references/cloud/models/token)
- This event triggers when a verification token for a user is validated.
Returns [Token Object](/docs/references/cloud/models/token)
{% /table %}
4 changes: 2 additions & 2 deletions src/partials/functions-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@
---

- `functions.*.update`
- This event triggers when a function is updated.
Returns [Function Object](/docs/references/cloud/models/function)
- This event triggers when a function is updated.
Returns [Function Object](/docs/references/cloud/models/function)
{% /table %}
4 changes: 2 additions & 2 deletions src/partials/messaging-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@
---

- `messages.*.update`
- This event triggers when a message is updated.
Returns [Message Object](/docs/references/cloud/models/message)
- This event triggers when a message is updated.
Returns [Message Object](/docs/references/cloud/models/message)
{% /table %}
4 changes: 2 additions & 2 deletions src/partials/storage-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@
---

- `buckets.*.update`
- This event triggers when a bucket is updated.
Returns [Bucket Object](/docs/references/cloud/models/bucket)
- This event triggers when a bucket is updated.
Returns [Bucket Object](/docs/references/cloud/models/bucket)
{% /table %}
4 changes: 4 additions & 0 deletions src/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,10 @@
"link": "/docs/installation",
"redirect": "/docs/advanced/self-hosting"
},
{
"link": "/keyboard",
"redirect": "/docs/tooling/keyboard"
},
{
"link": "/careers",
"redirect": "https://appwrite.careers"
Expand Down
5 changes: 5 additions & 0 deletions src/routes/docs/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@
label: 'Assistant',
href: '/docs/tooling/assistant',
icon: 'icon-sparkles'
},
{
label: 'Keyboard',
href: '/docs/tooling/keyboard',
icon: 'icon-sparkles'
}
]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ To enable a runtime, add it to the `_APP_FUNCTIONS_RUNTIMES` environment variabl
The example below would enable Dart 2.15, .NET 6.0, and Java 18 runtimes.

```bash
_APP_FUNCTIONS_RUNTIMES=dart-2.15, dotnet-6.0, java-18.0
_APP_FUNCTIONS_RUNTIMES=dart-2.15, dotnet-6.0, java-18.
```

You can find a full list of supported runtimes on the [environment variables page](/docs/advanced/self-hosting/environment-variables).
Expand Down
9 changes: 9 additions & 0 deletions src/routes/docs/tooling/keyboard/+layout.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script lang="ts">
import Docs from '$lib/layouts/Docs.svelte';
import Sidebar from '../../Sidebar.svelte';
</script>

<Docs variant="two-side-navs">
<Sidebar />
<slot />
</Docs>
41 changes: 41 additions & 0 deletions src/routes/docs/tooling/keyboard/+page.markdoc
Original file line number Diff line number Diff line change
@@ -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.
Binary file added static/images/docs/keyboard/appwriter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/docs/keyboard/dark/appwriter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3815f36

Please sign in to comment.