Skip to content
New issue

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

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

Already on GitHub? # to your account

Added a new tooling section and assistant page #7

Merged
merged 2 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion src/routes/docs/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@
const isTutorial = pathname.includes('/tutorials/');
const isQuickstart = pathname.includes('/quick-start/');
const isProduct = pathname.includes('/products/') || pathname.includes('/article');
const isTooling = pathname.includes('/tooling');
const isReference = pathname.includes('/reference');

if (isTutorial || isProduct || isAPIs || isSDKs || isQuickstart) {
if (isTutorial || isProduct || isAPIs || isSDKs || isQuickstart || isTooling) {
return 'two-side-navs';
} else if (isReference) {
return 'expanded';
Expand Down
21 changes: 16 additions & 5 deletions src/routes/docs/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,6 @@
href: '/docs/sdks',
icon: 'icon-cog'
},
{
label: 'Command Line',
href: '#',
icon: 'icon-terminal'
},
{
label: 'References',
href: '/docs/reference',
Expand Down Expand Up @@ -268,6 +263,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: '#',
Expand Down
37 changes: 37 additions & 0 deletions src/routes/docs/tooling/assistant/+page.markdoc
Original file line number Diff line number Diff line change
@@ -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.