From 121129cb1ae4134cb588ecd2578357673255d501 Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Wed, 13 Sep 2023 23:38:46 +0300 Subject: [PATCH] Added a new tooling section and assistant page --- src/routes/docs/+layout.svelte | 3 +- src/routes/docs/Sidebar.svelte | 21 ++++++++--- .../docs/tooling/assistant/+page.markdoc | 37 +++++++++++++++++++ 3 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 src/routes/docs/tooling/assistant/+page.markdoc diff --git a/src/routes/docs/+layout.svelte b/src/routes/docs/+layout.svelte index 51142566c6..430abdae98 100644 --- a/src/routes/docs/+layout.svelte +++ b/src/routes/docs/+layout.svelte @@ -6,9 +6,10 @@ function getDocsVariant(pathname: string): DocsLayoutVariant { const isTutorial = pathname.includes('/tutorials/'); const isProduct = pathname.includes('/products/') || pathname.includes('/article'); + const isTooling = pathname.includes('/tooling'); const isReference = pathname.includes('/reference'); - if (isTutorial || isProduct) { + if (isTutorial || isProduct || isTooling) { return 'two-side-navs'; } else if (isReference) { return 'expanded'; diff --git a/src/routes/docs/Sidebar.svelte b/src/routes/docs/Sidebar.svelte index e97e9de66b..66df020ed6 100644 --- a/src/routes/docs/Sidebar.svelte +++ b/src/routes/docs/Sidebar.svelte @@ -49,11 +49,6 @@ href: '#', icon: 'icon-cog' }, - { - label: 'Command Line', - href: '#', - icon: 'icon-terminal' - }, { label: 'References', href: '/docs/reference', @@ -224,6 +219,22 @@ } ] }, + { + label: 'Tooling', + href: '#', + items: [ + { + label: 'Command Line', + href: '#', + icon: 'icon-terminal' + }, + { + label: 'Assistant', + href: '/docs/tooling/assistant', + icon: 'icon-magic-wand' + } + ] + }, { label: 'Advanced', href: '#', diff --git a/src/routes/docs/tooling/assistant/+page.markdoc b/src/routes/docs/tooling/assistant/+page.markdoc new file mode 100644 index 0000000000..d14bcbddbf --- /dev/null +++ b/src/routes/docs/tooling/assistant/+page.markdoc @@ -0,0 +1,37 @@ +--- +layout: article +title: Assistant +description: AI-powered assistant for precise Appwrite tasks. Code snippets, troubleshooting, and more. +--- + +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. + +{% info title="Development" %} +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. +{% /info %} + +## Getting Started {% #getting-started %} + +To engage the Appwrite Assistant, access the Command Center within your Appwrite console, and proceed to the `Ask the AI` tab in the navigation. + +## Querying {% #querying %} + +The Appwrite Assistant accommodates queries related to Appwrite, encompassing topics such as: + +- How to add platform in the console? +- How to integrate Appwrite in my Flutter project? +- How can I create a user account? +- How to store a file in a bucket? + +## Optimizations {% #optimizations %} + +For optimal utilization of the Appwrite Assistant, consider the following recommendations: + +- **Precision**: Articulate queries with specificity. +- **Natural Language**: The Assistant comprehends plain English, obviating the need for technical terminology. +- **Query Refinement**: In cases of misinterpretation, rephrase queries. +- **Manual Documentation Search**: In scenarios where the Assistant falls short, manually search the Appwrite documentation. + +## Privacy {% #privacy %} + +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.