Add Fuse 0.6 docs

docs/botkube-cloud-auth.md

@@ -0,0 +1,40 @@
+---
+id: botkube-cloud-auth
+title: Authentication with Botkube Cloud
+sidebar_position: 8
+---
+
+# Authentication with Botkube Cloud
+
+Fuse is deeply integrated with Botkube Cloud. When you log in to Botkube Cloud, increased usage limits apply, and additional features are available.
+
+## Benefits
+
+### Increased usage limits
+
+Once you log in to Botkube Cloud, you get **4x AI token usage limit** for your machine, regardless the free or paid plan.
+
+### Additional features
+
+While being logged in to your Botkube Cloud account, you can access the following features:
+
+- [Knowledge documents upload](./knowledge-documents.md) (different limits apply for each plan),
+- [Custom instructions](./custom-instructions.md).
+
+All data for the features is shared between multiple memebers of your Botkube Cloud organization.
+
+## Log in
+
+To log in to your Botkube Cloud account, run:
+
+```shell
+botkube login
+```
+
+## Log out
+
+To log out from your Botkube Cloud account and delete local authentication data, run:
+
+```shell
+botkube logout
+```

docs/custom-instructions.md

@@ -0,0 +1,71 @@
+---
+id: custom-instructions
+title: Custom instructions
+sidebar_position: 6
+---
+
+# Custom instructions
+
+Fuse categorizes user prompts and applies custom AI assistant instructions for accurate responses.
+
+There are built-in instructions for some scenarios. You can learn more about them on the [Tutorials](./tutorials.md) page. However, you can also create your own, to tailor Fuse to your specific workflows and daily tasks.
+
+The custom instructions are applied dynamically. The AI model decides by itself whether to apply a given instruction, based on its relevance to the user prompt.
+
+:::info
+This feature requires [an active account on Botkube Cloud](./botkube-cloud-auth.md). All custom instructions are shared across all Fuse installations within your Botkube Cloud organization.
+:::
+
+## Browse and manage instructions
+
+To browse and manage available instructions, run:
+
+```shell
+fuse instructions browse
+```
+
+Then:
+
+- Navigate with up/down arrows through the list.
+- Filter the list with your search phrase after pressing `/`.
+- Press `e` to edit selected instruction.
+- Press `d` to delete selected instruction.
+- Press `a` to add [a new instruction](#add-a-new-instruction).
+
+## Add a new instruction
+
+To add a new custom instruction, run:
+
+- Using the default instruction template:
+
+  ```shell
+  fuse instructions add
+  ```
+
+- From a local file:
+
+  ```shell
+  fuse instructions add file.md
+  ```
+
+- From a URL:
+
+  ```shell
+  fuse instructions add https://example.com/file.md
+  ```
+
+### Custom instruction content
+
+The custom instruction must be a valid Markdown file, that contain a display name as a part of frontmatter metadata:
+
+```md
+---
+displayName: display-name # short name for the instruction
+---
+```
+
+While there aren't any further requirements for the Markdown instruction content, we recommend using the official default template ([available in the `fuse instructions add` command](#add-a-new-instruction)).
+
+The instruction might contain some broad guidelines, but also more specific, step-by-step, instructions.
+
+You can learn more about writing the instructions by searching for "prompt engineering" in the web.

docs/demo-environment.md

@@ -0,0 +1,13 @@
+---
+id: demo-environment
+title: Demo environment
+sidebar_position: 5
+---
+
+# Demo environment
+
+To make it easier to try out Fuse, we provide a demo environment.
+
+To use it, specify the `--with-demo-env` flag. By default, when running [`fuse tutorials`](./tutorials.md), you will be prompted if you want to use it as a part of the guided paths.
+
+The flag configures access to our public read-only Google Cloud Platform project with a Kubernetes cluster. All read-only operations are allowed.

docs/knowledge-documents.md

@@ -0,0 +1,25 @@
+---
+id: knowledge-documents
+title: Knowledge documents
+sidebar_position: 7
+---
+
+# Knowledge documents
+
+Make Fuse even smarter by uploading your documentation. For example: architectural documents, onboarding material, runbooks, post-mortems, etc.
+
+:::info
+This feature requires [an active account on Botkube Cloud](./botkube-cloud-auth.md). The user-supplied documentation is scoped to a given Botkube Cloud organization.
+:::
+
+## Manage uploaded files
+
+To manage the files, follow the steps:
+
+1. Navigate to the [Botkube Cloud dashboard](https://app.botkube.io)
+2. Click on the **Fuse CLI** tab.
+3. Under the **Customize Fuse Installations** section, find the **Knowledge Documents** card.
+
+Upload new files with the **Upload file(s)** button.
+
+To delete files, select the file(s) you want to delete and click **Delete selected file(s)**.

docs/overview.md

@@ -14,7 +14,7 @@ It helps you work smarter by:
 - Seamless tool integration,
 - Tailored assistance.
 
-Botkube Fuse delivers tailored guidance for your unique infrastructure, pipelines, and services via the interactive command line interface.
+Fuse delivers tailored guidance for your unique infrastructure, pipelines, and services via the interactive command line interface.
 
 ![Using fuse in CLI](./assets/prompt.gif)
 
@@ -30,7 +30,7 @@ Fuse categorizes your queries and applies custom AI assistant instructions for a
 
 During AI processing phase, Fuse integrates with your locally installed tools, with full control over the process.
 
-Available capabilities:
+Available capabilities are:
 
 - Google Cloud CLI (`gcloud`),
 - Kubernetes CLI (`kubectl`),
@@ -40,17 +40,6 @@ Available capabilities:
 - Filesystem operations,
 - and more!
 
-## Featured scenarios
-
-We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
-
-- GitHub Actions secret management,
-- GitHub Actions pipeline run analysis,
-- GKE troubleshooting with IAM permission errors,
-- Local environment operations and debugging.
-
-See the [Looking for inspiration](./usage.md#looking-for-inspiration) section to learn how to check out the scenarios.
-
 ## 📖 Learn more
 
-Read more about Botkube Fuse features on [the official website](https://botkube.io/fuse/).
+Learn more about Fuse on [the official landing page](https://botkube.io/fuse/).

docs/tutorials.md

@@ -0,0 +1,24 @@
+---
+id: tutorials
+title: Tutorials
+sidebar_position: 4
+---
+
+# Tutorials
+
+To browse available example use-cases, run `fuse tutorials` in your terminal.
+
+Tutorials command contains guided paths to get started with Fuse. Simply select one of the scenarios, like "Getting summary of CI/CD pipeline runs", and pick one of the prompts.
+
+As a part of the tutorials, you can configure optional access to the [Demo environment](./demo-environment.md).
+
+## Featured scenarios
+
+We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
+
+- GitHub Actions secret management,
+- GitHub Actions pipeline run analysis,
+- GKE troubleshooting with IAM permission errors,
+- Local environment operations and debugging.
+
+You can see the video recordings of the scenarios on the [official landing page](https://botkube.io/fuse).

docs/usage.md

@@ -37,6 +37,4 @@ fuse 'list files in the current directory and provide me better organization str
 
 ### Looking for inspiration?
 
-💡 If you are curious what Fuse can do for you, simply run `fuse scenarios` in your terminal!
-
-![scenarios.gif](./assets/scenarios.gif)
+Read the [Tutorials](./tutorials.md) document with guided paths to get started!

versioned_docs/version-0.5/tutorials.md

@@ -0,0 +1,22 @@
+---
+id: tutorials
+title: Tutorials
+sidebar_position: 4
+---
+
+# Tutorials
+
+To browse available example use-cases, run `fuse tutorials` in your terminal.
+
+Tutorials command contains guided paths to get started with Fuse. Simply select one of the scenarios, like "Getting summary of CI/CD pipeline runs", and pick one of the prompts.
+
+## Featured scenarios
+
+We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
+
+- GitHub Actions secret management,
+- GitHub Actions pipeline run analysis,
+- GKE troubleshooting with IAM permission errors,
+- Local environment operations and debugging.
+
+You can see the video recordings of the scenarios on the [official landing page](https://botkube.io/fuse).

versioned_docs/version-0.5/usage.md

@@ -37,6 +37,4 @@ fuse 'list files in the current directory and provide me better organization str
 
 ### Looking for inspiration?
 
-💡 If you are curious what Fuse can do for you, simply run `fuse scenarios` in your terminal!
-
-![scenarios.gif](./assets/scenarios.gif)
+Read the [Tutorials](./tutorials.md) document with guided paths to get started!

versioned_docs/version-0.6/botkube-cloud-auth.md

@@ -0,0 +1,40 @@
+---
+id: botkube-cloud-auth
+title: Authentication with Botkube Cloud
+sidebar_position: 8
+---
+
+# Authentication with Botkube Cloud
+
+Fuse is deeply integrated with Botkube Cloud. When you log in to Botkube Cloud, increased usage limits apply, and additional features are available.
+
+## Benefits
+
+### Increased usage limits
+
+Once you log in to Botkube Cloud, you get **4x AI token usage limit** for your machine, regardless the free or paid plan.
+
+### Additional features
+
+While being logged in to your Botkube Cloud account, you can access the following features:
+
+- [Knowledge documents upload](./knowledge-documents.md) (different limits apply for each plan),
+- [Custom instructions](./custom-instructions.md).
+
+All data for the features is shared between multiple memebers of your Botkube Cloud organization.
+
+## Log in
+
+To log in to your Botkube Cloud account, run:
+
+```shell
+botkube login
+```
+
+## Log out
+
+To log out from your Botkube Cloud account and delete local authentication data, run:
+
+```shell
+botkube logout
+```

versioned_docs/version-0.6/custom-instructions.md

@@ -0,0 +1,71 @@
+---
+id: custom-instructions
+title: Custom instructions
+sidebar_position: 6
+---
+
+# Custom instructions
+
+Fuse categorizes user prompts and applies custom AI assistant instructions for accurate responses.
+
+There are built-in instructions for some scenarios. You can learn more about them on the [Tutorials](./tutorials.md) page. However, you can also create your own, to tailor Fuse to your specific workflows and daily tasks.
+
+The custom instructions are applied dynamically. The AI model decides by itself whether to apply a given instruction, based on its relevance to the user prompt.
+
+:::info
+This feature requires [an active account on Botkube Cloud](./botkube-cloud-auth.md). All custom instructions are shared across all Fuse installations within your Botkube Cloud organization.
+:::
+
+## Browse and manage instructions
+
+To browse and manage available instructions, run:
+
+```shell
+fuse instructions browse
+```
+
+Then:
+
+- Navigate with up/down arrows through the list.
+- Filter the list with your search phrase after pressing `/`.
+- Press `e` to edit selected instruction.
+- Press `d` to delete selected instruction.
+- Press `a` to add [a new instruction](#add-a-new-instruction).
+
+## Add a new instruction
+
+To add a new custom instruction, run:
+
+- Using the default instruction template:
+
+  ```shell
+  fuse instructions add
+  ```
+
+- From a local file:
+
+  ```shell
+  fuse instructions add file.md
+  ```
+
+- From a URL:
+
+  ```shell
+  fuse instructions add https://example.com/file.md
+  ```
+
+### Custom instruction content
+
+The custom instruction must be a valid Markdown file, that contain a display name as a part of frontmatter metadata:
+
+```md
+---
+displayName: display-name # short name for the instruction
+---
+```
+
+While there aren't any further requirements for the Markdown instruction content, we recommend using the official default template ([available in the `fuse instructions add` command](#add-a-new-instruction)).
+
+The instruction might contain some broad guidelines, but also more specific, step-by-step, instructions.
+
+You can learn more about writing the instructions by searching for "prompt engineering" in the web.

versioned_docs/version-0.6/demo-environment.md

@@ -0,0 +1,13 @@
+---
+id: demo-environment
+title: Demo environment
+sidebar_position: 5
+---
+
+# Demo environment
+
+To make it easier to try out Fuse, we provide a demo environment.
+
+To use it, specify the `--with-demo-env` flag. By default, when running [`fuse tutorials`](./tutorials.md), you will be prompted if you want to use it as a part of the guided paths.
+
+The flag configures access to our public read-only Google Cloud Platform project with a Kubernetes cluster. All read-only operations are allowed.