Skip to content

Commit 05e9efc

Browse files
author
Vincent (Wen Yu) Ge
authored
Merge pull request #7 from appwrite/feat-new-assistant-page
Added a new tooling section and assistant page
2 parents 629ee9c + 003b8c9 commit 05e9efc

3 files changed

Lines changed: 55 additions & 6 deletions

File tree

src/routes/docs/+layout.svelte

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@
99
const isTutorial = pathname.includes('/tutorials/');
1010
const isQuickstart = pathname.includes('/quick-start/');
1111
const isProduct = pathname.includes('/products/') || pathname.includes('/article');
12+
const isTooling = pathname.includes('/tooling');
1213
const isReference = pathname.includes('/reference');
1314
14-
if (isTutorial || isProduct || isAPIs || isSDKs || isQuickstart) {
15+
if (isTutorial || isProduct || isAPIs || isSDKs || isQuickstart || isTooling) {
1516
return 'two-side-navs';
1617
} else if (isReference) {
1718
return 'expanded';

src/routes/docs/Sidebar.svelte

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,6 @@
4949
href: '/docs/sdks',
5050
icon: 'icon-cog'
5151
},
52-
{
53-
label: 'Command Line',
54-
href: '#',
55-
icon: 'icon-terminal'
56-
},
5752
{
5853
label: 'References',
5954
href: '/docs/reference',
@@ -268,6 +263,22 @@
268263
}
269264
]
270265
},
266+
{
267+
label: 'Tooling',
268+
href: '#',
269+
items: [
270+
{
271+
label: 'Command Line',
272+
href: '#',
273+
icon: 'icon-terminal'
274+
},
275+
{
276+
label: 'Assistant',
277+
href: '/docs/tooling/assistant',
278+
icon: 'icon-magic-wand'
279+
}
280+
]
281+
},
271282
{
272283
label: 'Advanced',
273284
href: '#',
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: article
3+
title: Assistant
4+
description: AI-powered assistant for precise Appwrite tasks. Code snippets, troubleshooting, and more.
5+
---
6+
7+
The **Appwrite Assistant** is an AI-powered tool engineered to augment Appwrite-related tasks with technical precision. It operates on a foundation of training data sourced from the Appwrite documentation website, enabling it to furnish insights into Appwrite's features, APIs, and documentation. Additionally, it offers functionality for code snippet generation, sample project creation, and problem troubleshooting.
8+
9+
{% info title="Development" %}
10+
While the Appwrite Assistant remains under active development and is considered experimental, it undergoes incremental refinement. Its proficiency in comprehending user queries and delivering relevant responses improves with sustained usage.
11+
{% /info %}
12+
13+
## Getting Started {% #getting-started %}
14+
15+
To engage the Appwrite Assistant, access the Command Center within your Appwrite console, and proceed to the `Ask the AI` tab in the navigation.
16+
17+
## Querying {% #querying %}
18+
19+
The Appwrite Assistant accommodates queries related to Appwrite, encompassing topics such as:
20+
21+
- How to add platform in the console?
22+
- How to integrate Appwrite in my Flutter project?
23+
- How can I create a user account?
24+
- How to store a file in a bucket?
25+
26+
## Optimizations {% #optimizations %}
27+
28+
For optimal utilization of the Appwrite Assistant, consider the following recommendations:
29+
30+
- **Precision**: Articulate queries with specificity.
31+
- **Natural Language**: The Assistant comprehends plain English, obviating the need for technical terminology.
32+
- **Query Refinement**: In cases of misinterpretation, rephrase queries.
33+
- **Manual Documentation Search**: In scenarios where the Assistant falls short, manually search the Appwrite documentation.
34+
35+
## Privacy {% #privacy %}
36+
37+
When you use the Appwrite Assistant, your questions are sent to OpenAI to generate a response. OpenAI may collect and store your questions and responses for the purposes of improving their services.

0 commit comments

Comments
 (0)