Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Keyboard documentation #1025

Merged
merged 43 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
dc25909
doc create and add content to keyboard-documentation, change redirect…
choir241 Jun 10, 2024
116eb16
doc-update alt text for images
choir241 Jun 10, 2024
264e62f
update word flow, change wording for article description, remove tabl…
choir241 Jun 10, 2024
d7c2b18
revert pnpm-lock.yaml changes
choir241 Jun 10, 2024
639c56e
doc - update wording in article description
choir241 Jun 10, 2024
d1eb38a
doc: seperated table into global and project shortcuts, reword articl…
choir241 Jun 10, 2024
e8dce55
add right side navigation for keyboard docs
choir241 Jun 10, 2024
d7dcf6d
docs: add social media links to appwriter section
choir241 Jun 10, 2024
ac8b4f1
doc: update first paragraph/section with better word choice/flow of w…
choir241 Jun 10, 2024
becd24a
doc: reword and change word flows of accessibility, shortcut keys and…
choir241 Jun 11, 2024
72f680b
doc: add mac and windows commands for command center, change any list…
choir241 Jun 11, 2024
53ddd99
doc: split accessibility into 2 paragraphs, add paragraph explaining …
choir241 Jun 11, 2024
286afa4
doc: update wording/setence structure
choir241 Jun 11, 2024
ae261be
docs: change title from Appwriter Specs to Specifications
choir241 Jun 11, 2024
94c85b5
docs: made suggested changes to content, word choices, and sentence s…
choir241 Jun 12, 2024
6343684
docs: make additional content changes to reflect feedback
choir241 Jun 12, 2024
78eee6b
docs: update doc word choice, sentence structure, and flow of sentenc…
choir241 Jun 12, 2024
1ef654a
docs: update description, AI shortcut, and first intro paragraph
choir241 Jun 12, 2024
515b896
docs: move keyboard article under platform overview, move appwriter a…
choir241 Jun 13, 2024
0ba85e7
remove /docs/tooling/keyboard from Sidebar.svelte
choir241 Jun 13, 2024
ebf1a03
docs: update redirect url for assistant, keyboard and appwriter
choir241 Jun 13, 2024
7d1f16b
docs: update Appwriter label for sidebar, move accessibility section …
choir241 Jun 13, 2024
90377da
Update src/routes/docs/tooling/assistant/appwriter/+page.markdoc
choir241 Jun 14, 2024
0cceb36
Update src/routes/docs/advanced/platform/shortcuts/+page.markdoc
choir241 Jun 14, 2024
cf7d199
docs: move the appwrite and keyboard shortcuts pages under command ce…
choir241 Jun 14, 2024
cda46fb
docs: move appwriter to own separate section under tooling, move comm…
choir241 Jun 17, 2024
a94a543
docs: update redirect.json and move command center section under glob…
choir241 Jun 17, 2024
5c6781b
docs: fix broken command-center href link
choir241 Jun 17, 2024
5bf25c1
docs: remove docs/tooling/the-appwriter
choir241 Jun 18, 2024
85e7d3d
docs: update /docs/tooling/command-center and /docs/tooling/assistant…
choir241 Jun 18, 2024
daac6da
Update src/routes/docs/tooling/appwriter/+page.markdoc
choir241 Jun 18, 2024
268c367
Update src/routes/docs/tooling/appwriter/+page.markdoc
choir241 Jun 18, 2024
1a6abae
docs: update macOS content and add transition to accessibilty section
choir241 Jun 18, 2024
46ea0e1
docs: add sidebar navigation to the appwriter article
choir241 Jun 18, 2024
195c74a
docs: change social media links for winning appwriter to list-style
choir241 Jun 18, 2024
83c841a
Update src/routes/docs/advanced/platform/shortcuts/+page.markdoc
choir241 Jun 19, 2024
72d975a
Update src/routes/docs/tooling/appwriter/+page.markdoc
choir241 Jun 19, 2024
595a39d
docs: add primary action keyboard shortcuts, move shortcut to first c…
choir241 Jun 19, 2024
96ee8f2
Merge branch 'docs-keyboard' of https://github.com/appwrite/website i…
choir241 Jun 19, 2024
37f650d
docs: add separate section for items included in the appwriter box
choir241 Jun 19, 2024
b2ba161
docs: change appwriter backlight title and change items in appwriter …
choir241 Jun 19, 2024
d87c90a
docs: change whats in the box list-style to sentence structure
choir241 Jun 19, 2024
8615fea
docs: change last bullet point to full sentence and remove period fro…
choir241 Jun 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion 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/assistant/appwriter"
},
{
"link": "/careers",
"redirect": "https://appwrite.careers"
Expand All @@ -675,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 @@ -109,7 +109,7 @@
},
{
label: 'Assistant',
href: '/docs/tooling/assistant',
href: '/docs/tooling/assistant/assistant',
icon: 'icon-sparkles'
stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
}
]
Expand Down
4 changes: 4 additions & 0 deletions src/routes/docs/advanced/platform/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
{
label: 'Overview',
href: '/docs/advanced/platform'
},
{
label: 'Shortcuts',
href: '/docs/advanced/platform/shortcuts'
}
]
},
Expand Down
49 changes: 49 additions & 0 deletions src/routes/docs/advanced/platform/shortcuts/+page.markdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: article
title: Keyboard Shortcuts
stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
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`|

stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
## 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`|
|Create Organization|`C` then `O`|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets remove the last point. its not relevant to the scope of projects


stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
# 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.
29 changes: 25 additions & 4 deletions src/routes/docs/tooling/assistant/+layout.svelte
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
<script lang="ts">
import Docs from '$lib/layouts/Docs.svelte';
import Sidebar from '../../Sidebar.svelte';
import Docs from '$lib/layouts/Docs.svelte';
import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte';

const parent: NavParent = {
href: '/docs',
label: 'Assistant'
};

const navigation: NavTree = [
{
label: 'Guides',
items: [
{
label: 'Assistant',
href: '/docs/tooling/assistant/assistant'
},
{
label: 'Appwriter',
href: '/docs/tooling/assistant/appwriter'
}
]
}
];
</script>

<Docs variant="two-side-navs">
<Sidebar />
<slot />
<Sidebar {navigation} {parent} />
<slot />
</Docs>
35 changes: 35 additions & 0 deletions src/routes/docs/tooling/assistant/appwriter/+page.markdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: article
title: The Appwriter
description: Learn about the custom Appwriter mechanical keyboard and its specifications
---

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

{% only_light %}
![The Appwriter](/images/docs/keyboard/appwriter.png)
{% /only_light %}

The Appwriter is an exclusive mechanical keyboard custom-designed by the Appwrite team. It is optimized to improve developer productivity and is specially tuned to use with the Appwrite Console.

The Appwriter uses icons from the Appwrite Console and Docs on specific keys, making memorizing keyboard shortcuts easier. For example, `G` then `D` is the shortcut for navigating to your project's databases, and the icon on the `D` key matches the icon for Appwrite Databases.

## Specifications

The box includes the Appwriter keyboard, a USB-C data/charging cable, a 2-in-1 keycap and switch puller, extra PC layout keycaps, and an information card with a QR code. The keyboard comes with Mac layout keys pre-installed for MacOS which can also be swapped with the included PC keycaps.
stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved

|Specification|Details|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should separate the specifications and the contents of the box 🤔

|----|----|
|Battery|3000mAh Rechargeable battery|
|Design|75% Compact design keyboard|
|Keycaps|84 Custom dye sublimated PBT keycaps|
|Switches|Gateron g pro yellow pre-lubed switches|
|Connections|Tri-mode connectivity (2.4Ghz wireless / bluetooth / wired USB-C)|
|Case|Noise dampening case-foam|
|RGB Backlight|16 Million colors & multiple lighting effects|
|Switch Support|Hot-swappable switches with 3 & 5 pin|
|N-Key|N-key rollover|

stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
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/).
stnguyen90 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions src/routes/docs/tooling/command-center/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Command Center
description: Appwrite Command Center enhances developer experience with AI, keyboard shortcuts, and context-aware search for efficient navigation and task execution.
---

The Appwrite **Command Center** is designed to improve the developer experience by enabling straightforward navigation and exploration of features, settings, and sections of the Appwrite Console. The Command Center is enhanced with [AI capabilities](/docs/tooling/assistant) and is the home of the Appwrite assistant. It allows you to execute tasks and access features within the Appwrite Console efficiently using keyboard shortcuts and advanced context-aware search.
The Appwrite **Command Center** is designed to improve the developer experience by enabling straightforward navigation and exploration of features, settings, and sections of the Appwrite Console. The Command Center is enhanced with [AI capabilities](/docs/tooling/assistant/assistant) and is the home of the Appwrite assistant. It allows you to execute tasks and access features within the Appwrite Console efficiently using keyboard shortcuts and advanced context-aware search.

{% only_dark %}
![Command center](/images/docs/command-center/dark/command-center.png)
Expand All @@ -29,7 +29,7 @@ The Command Center offers context-sensitive commands for creating entities like

# AI Assistant {% #ai-assistant %}

An integral part of the Command Center is the [Appwrite AI Assistant](/docs/tooling/assistant), trained on Appwrite's extensive documentation, content, and knowledge base. The Assistant can answer Appwrite-related queries with detailed explanations, step-by-step instructions, and relevant code snippets, enhancing your ability to utilize Appwrite quickly and efficiently.
An integral part of the Command Center is the [Appwrite AI Assistant](/docs/tooling/assistant/assistant), trained on Appwrite's extensive documentation, content, and knowledge base. The Assistant can answer Appwrite-related queries with detailed explanations, step-by-step instructions, and relevant code snippets, enhancing your ability to utilize Appwrite quickly and efficiently.

# Keyboard optimization {% #keyboard-optimization %}

Expand Down
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.
Loading