LukeParke/website
1
0
Fork 0
mirror of https://github.com/LukeHagar/website.git synced 2025-12-10 04:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move appwriter to own separate section under tooling, move command center table to second table and add text content, update word choice and sentence structure, fix title to sentence casing

Browse Source
This commit is contained in:
choir27
2024-06-17 16:58:41 -04:00
parent cf7d199492
commit cda46fbb3c
10 changed files with 59 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/routes/docs/Sidebar.svelte
View File

@@ -104,13 +104,18 @@
}, },
{ {
label: 'Command Center', label: 'Command Center',
href: '/docs/tooling/command-center/command-center', href: '/docs/tooling/command-center',
icon: 'web-icon-command' icon: 'web-icon-command'
}, },
{ {
label: 'Assistant', label: 'Assistant',
href: '/docs/tooling/assistant/assistant', href: '/docs/tooling/assistant',
icon: 'icon-sparkles' icon: 'icon-sparkles'
},
{
label: "The Appwriter",
href: '/docs/tooling/appwriter',
icon: 'icon-text'
} }
] ]
}, },

4
src/routes/docs/advanced/platform/+layout.svelte
View File

@@ -14,6 +14,10 @@
{ {
label: 'Overview', label: 'Overview',
href: '/docs/advanced/platform' href: '/docs/advanced/platform'
},
{
label: 'Keyboard Shortcuts',
href: '/docs/advanced/platform/shortcuts'
} }
] ]
}, },

39
src/routes/docs/advanced/platform/shortcuts/+page.markdoc
View File

@@ -1,24 +1,19 @@
--- ---
layout: article layout: article
title: Keyboard Shortcuts title: Keyboard shortcuts
description: Learn to navigate the Appwrite Console efficiently and effectively with your keyboard description: Learn to navigate the Appwrite Console efficiently and effectively with your keyboard
--- ---
The Appwrite Console was designed with a keyboard first approach. Developer experience is greatly improved by virtue of the keyboard's ease of use, quick and seamless execution of essential actions and the consistency of shortcut keys to traverse the Appwrite Console. The Appwrite Console was designed with a keyboard first approach. The Appwrite Console supports keyboard shortcuts that make it easier to navigate and perform actions quicker.
# Shortcuts {% #shortcuts %} # Shortcuts {% #shortcuts %}
The Appwrite Console supports keyboard shortcuts that make it easier to navigate and perform common actions quicker. The shortcuts use the following pattern: use the first letter from the call to action followed by the resource, product, service, or page you're targeting. For example, the shortcut keys `G` + `S` navigates to the project's Storage screen. Similarly, the shortcut `G` + `F` navigates to the project's Functions screen. However, there are some exceptions. The shortcut `G` + `E` navigates to project Settings, because `G` + `S` is in use for Storage. This pattern is used to make usage of shortcuts consistent and predictable. The Appwrite Console supports keyboard shortcuts that make it easier to navigate and perform common actions quicker. The shortcuts use the following pattern: use the first letter from the call to action followed by the resource, product, service, or page you're targeting. For example, the shortcut keys `G` + `S` navigates to the project's Storage screen. Similarly, the shortcut `G` + `F` navigates to the project's Functions screen. However, when there's a conflict with a shortcut key, the following letter is used. For example, since S is already used for Storage, the shortcut for Settings is E. This pattern is used to make usage of shortcuts consistent and predictable.
## Global shortcuts {% #global-shortcuts %} ## Global shortcuts {% #global-shortcuts %}
Developers can also utilize global shortcuts anywhere in the Appwrite Console, allowing instant access to these features from any page on the Console. Developers can also utilize global shortcuts anywhere in the Appwrite Console, allowing instant access to these features from any page on the Console.
|PC (Windows / Linux)|macOS|Action|
|----|----|----|
|`Ctrl` + `K`|`⌘` + `K`|Access Command Center|
|Shortcut|Action| |Shortcut|Action|
|----|----| |----|----|
|Set theme to light|`T` then `L`| |Set theme to light|`T` then `L`|
@@ -26,22 +21,30 @@ Developers can also utilize global shortcuts anywhere in the Appwrite Console, a
|Set theme to dark|`T` then `A`| |Set theme to dark|`T` then `A`|
|Open Appwrite Assistant|`A` then `I`| |Open Appwrite Assistant|`A` then `I`|
> Pro TipThe Command Center can be triggered from any screen to get quick access to hints and shortcuts. ## Command center
|PC (Windows / Linux)|macOS|Action|
|----|----|----|
|`Ctrl` + `K`|`⌘` + `K`|Access Command Center|
All the Appwrite shortcuts can be found in the [command center](https://appwrite.io/docs/tooling/command-center).
Use the command center to search for commands or the current page's content.
## Project shortcuts {% #project-shortcuts %} ## Project shortcuts {% #project-shortcuts %}
Within the context of a project, developers can utilize project shortcuts. These shortcuts are automatically enabled once a project is selected on the Console. These shortcuts allow quick access to the project's database, storage, messaging, auth, settings, and overview pages. Within the context of a project, developers can utilize project shortcuts. These shortcuts are automatically enabled once a project is selected on the Console. These shortcuts allow quick access to the project's database, storage, messaging, auth, settings, and overview pages.
|Shortcut|Action| |Shortcut|Action|
|----|----| |----|----|
|Go to Auth|`G` then `A`| |Go to auth|`G` then `A`|
|Go to Storage|`G` then `S`| |Go to storage|`G` then `S`|
|Go to Databases|`G` then `D`| |Go to databases|`G` then `D`|
|Go to Functions|`G` then `F`| |Go to functions|`G` then `F`|
|Go to Projects|`G` then `P`| |Go to projects|`G` then `P`|
|Go to Overview|`G` then `O`| |Go to overview|`G` then `O`|
|Go to Messaging|`G` then `M`| |Go to messaging|`G` then `M`|
|Go to Settings|`G` then `E`| |Go to settings|`G` then `E`|
|Create Organization|`C` then `O`| |Create organization|`C` then `O`|
# Accessibility {% #accessibility %} # Accessibility {% #accessibility %}

9
src/routes/docs/tooling/appwriter/+layout.svelte Normal file
View File

@@ -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>

8
src/routes/docs/tooling/assistant/appwriter/+page.markdoc → src/routes/docs/tooling/appwriter/+page.markdoc
View File

@@ -32,4 +32,10 @@ The box includes the Appwriter keyboard, a USB-C data/charging cable, a 2-in-1 k
|Switch Support|Hot-swappable switches with 3 & 5 pin| |Switch Support|Hot-swappable switches with 3 & 5 pin|
|N-Key|N-key rollover| |N-Key|N-key rollover|
The Appwriter is currently exclusive to Appwrite events and giveaways. To get your hands on an Appwriter, look out for events & giveaways on our social media: [Discord](https://discord.com/invite/GSeTUeA), [Github](https://github.com/appwrite/appwrite), [X](https://x.com/intent/follow?screen_name=appwrite) and [YouTube](https://www.youtube.com/c/appwrite). Later this year, the Appwriter will be available for purchase in the [Appwrite Store](https://appwrite.store/). Press `Fn + Home` to change the RGB backlight effect and cycle through all the lights.
## How to get the Appwriter
The Appwriter is currently exclusive to Appwrite events and giveaways.
To get your hands on an Appwriter, look out for events & giveaways on our social media: [Discord](https://appwrite.io/discord), [Github](https://github.com/appwrite/appwrite), [X](https://x.com/appwrite), and [YouTube](https://www.youtube.com/c/appwrite).
Later this year, the Appwriter will be available for purchase in the [Appwrite Store](https://appwrite.store/).

27
src/routes/docs/tooling/command-center/+layout.svelte
View File

@@ -1,32 +1,9 @@
<script lang="ts"> <script lang="ts">
import Docs from '$lib/layouts/Docs.svelte'; import Docs from '$lib/layouts/Docs.svelte';
import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte'; import Sidebar from '$lib/layouts/Sidebar.svelte';
const parent: NavParent = {
href: '/docs',
label: 'Command Center'
};
const navigation: NavTree = [
{
label: 'Guides',
items: [
{
label: 'Command Center',
href: '/docs/tooling/command-center/command-center'
},{
label: 'Keyboard Shortcuts',
href: '/docs/tooling/command-center/keyboard-shortcuts'
},{
label: 'The Appwriter',
href: '/docs/tooling/command-center/the-appwriter'
}
]
}
];
</script> </script>
<Docs variant="two-side-navs"> <Docs variant="two-side-navs">
<Sidebar {navigation} {parent} /> <Sidebar />
<slot /> <slot />
</Docs> </Docs>

0
src/routes/docs/tooling/command-center/command-center/+page.markdoc → src/routes/docs/tooling/command-center/+page.markdoc
View File

64
src/routes/docs/tooling/command-center/keyboard-shortcuts/+page.markdoc
View File

@@ -1,64 +0,0 @@
---
layout: article
title: Keyboard Shortcuts
description: Learn to navigate the Appwrite Console efficiently and effectively with your keyboard
---
The Appwrite Console was designed with a keyboard first approach. Developer experience is greatly improved by virtue of the keyboard's ease of use, quick and seamless execution of essential actions and the consistency of shortcut keys to traverse the Appwrite Console.
# Shortcuts {% #shortcuts %}
The Appwrite Console supports keyboard shortcuts that make it easier to navigate and perform common actions quicker. The shortcuts use the following pattern: use the first letter from the call to action followed by the resource, product, service, or page you're targeting. For example, the shortcut keys `G` + `S` navigates to the project's Storage screen. Similarly, the shortcut `G` + `F` navigates to the project's Functions screen. However, there are some exceptions. The shortcut `G` + `E` navigates to project Settings, because `G` + `S` is in use for Storage. This pattern is used to make usage of shortcuts consistent and predictable.
## Global shortcuts {% #global-shortcuts %}
Developers can also utilize global shortcuts anywhere in the Appwrite Console, allowing instant access to these features from any page on the Console.
|PC (Windows / Linux)|macOS|Action|
|----|----|----|
|`Ctrl` + `K`|`⌘` + `K`|Access Command Center|
|Shortcut|Action|
|----|----|
|Set theme to light|`T` then `L`|
|Set theme to dark|`T` then `D`|
|Set theme to dark|`T` then `A`|
|Open Appwrite Assistant|`A` then `I`|
## Project shortcuts {% #project-shortcuts %}
Within the context of a project, developers can utilize project shortcuts. These shortcuts are automatically enabled once a project is selected on the Console. These shortcuts allow quick access to the project's database, storage, messaging, auth, settings, and overview pages.
|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 Messaging|`G` then `M`|
|Go to Settings|`G` then `E`|
# Primary Actions
Each screen on the console has a concept of a primary action.
For example, in the Functions screen, the primary action would be creating a function, in the Databases screen, it would be creating a database and so on.
The primary actions are usually triggered using the `C` key as seen in the table below.
|Shortcut|Action|
|----|----|
|Create project (on projects screen)| `C` then `P`|
|Create organization|`C` then `O`|
|Create API key (on overview screen)|`C` then `K`|
|Create database (on database screen)|`C` then `A`|
|Create collection (on collection screen)|`C`|
|Create document (on documents screen)|`C` then `D`|
|Create attribute (on documents screen)|`C` then `T`|
# Accessibility {% #accessibility %}
We are committed to making the Appwrite Console accessible to all developers by following the AA-level standards of the [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels). Following these standards ensures that the Console is usable by people with visual, auditory, physical, speech, cognitive, language, learning, and neurological disabilities.
Good contrast between text and backgrounds, resizable text without loss of content or functionality, and navigable interfaces via keyboard and screen readers guarantee an inclusive environment and allow developers to perform their tasks efficiently. Adhering to these guidelines ensures that the Appwrite Console complies with legal requirements and promotes a positive developer experience for everyone.

9
src/routes/docs/tooling/the-appwriter/+layout.svelte Normal file
View File

@@ -0,0 +1,9 @@
<script lang="ts">
import Docs from '$lib/layouts/Docs.svelte';
import Sidebar from '$lib/layouts/Sidebar.svelte';
</script>
<Docs variant="two-side-navs">
<Sidebar />
<slot />
</Docs>

0
src/routes/docs/tooling/command-center/the-appwriter/+page.markdoc → src/routes/docs/tooling/the-appwriter/+page.markdoc
View File