Merge pull request #46 from quixio/docs/update-docs-9678411687

Update docs for the release 0.0.1-20240626.1

docs/Reference/applications/index.gen.md

@@ -17,5 +17,5 @@ quix applications [command] [options]
 - [convert](convert.md) : Converts applications from and to library item format
 - [create](create.md) : Creates a new application locally based on a code sample of the library
 - [list](list.md) : Lists all the local applications of the project
-- [variables](variables\index.md) : Manage your local application's variables
+- [variables](variables/index.md) : Manage your local application's variables
 

docs/Reference/applications/list.gen.md

@@ -1,19 +1,19 @@
-# applications list
-
-## Overview
-
-Lists all the local applications of the project
-
-**Aliases:** `list`, `ls`
-
-**Usage:**
-
-```
-quix applications list [options]
-```
-
-**Options:**
-
+# applications list
+
+## Overview
+
+Lists all the local applications of the project
+
+**Aliases:** `list`, `ls`
+
+**Usage:**
+
+```
+quix applications list [options]
+```
+
+**Options:**
+
 - `-o, --output <json|table>` : Output type of the retrieved data
-- `-d, --directory <directory>` : Base directory (defaults to current directory)
-
+- `-d, --directory <directory>` : Base directory (defaults to current directory)
+

docs/Reference/cloud/applications/index.gen.md

@@ -15,6 +15,6 @@ quix cloud applications [command] [options]
 **Commands:**
 
 - [get](get.md) : Get an application in the specified environment
-- [library](library\index.md) : Manage the library items of an environment
+- [library](library/index.md) : Manage the library items of an environment
 - [list](list.md) : Get all applications in the specified environment
 

docs/Reference/cloud/index.gen.md

@@ -14,11 +14,11 @@ quix cloud [command] [options]
 
 **Commands:**
 
-- [organisations](organisations\index.md) : Manage your organisation
-- [projects](projects\index.md) : Manage the projects of the current organisation
-- [environments](environments\index.md) : Manage the environments of your projects (e.g., Dev, Staging, Production)
-- [applications](applications\index.md) : Manage the applications of an environment
-- [deployments](deployments\index.md) : Manage the deployments of an environment
-- [topics](topics\index.md) : Manage the topics of an environment
-- [users](users\index.md) : Manage the users of the organisation including audit, permissions and tokens
+- [organisations](organisations/index.md) : Manage your organisation
+- [projects](projects/index.md) : Manage the projects of the current organisation
+- [environments](environments/index.md) : Manage the environments of your projects (e.g., Dev, Staging, Production)
+- [applications](applications/index.md) : Manage the applications of an environment
+- [deployments](deployments/index.md) : Manage the deployments of an environment
+- [topics](topics/index.md) : Manage the topics of an environment
+- [users](users/index.md) : Manage the users of the organisation including audit, permissions and tokens
 

docs/Reference/cloud/users/index.gen.md

@@ -17,6 +17,6 @@ quix cloud users [command] [options]
 - [audit](audit.md) : Get the auditing details of the users of your organization
 - [current](current.md) : Gets the details of the currently-authenticated user
 - [list](list.md) : List all users in the organisation
-- [permissions](permissions\index.md) : Manage the user permissions
-- [tokens](tokens\index.md) : Manage the personal access tokens of the current user
+- [permissions](permissions/index.md) : Manage the user permissions
+- [tokens](tokens/index.md) : Manage the personal access tokens of the current user
 

docs/Reference/cloud/users/tokens/create.gen.md

@@ -19,6 +19,6 @@ quix cloud users tokens create <name> [options]
 **Options:**
 
 - `-o, --output <json|table>` : Output type of the retrieved data
-- `--expires-at <expires-at>` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-21]
+- `--expires-at <expires-at>` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-26]
 - `-p, --permission-assignments <permission-assignments> (REQUIRED)` : Array of permission assignments in the format "[{Scope, Permission, Permission, ..}, {Scope, Permission, Permission, ..}, ...]"
 

docs/Reference/contexts/broker/set.gen.md

@@ -1,26 +1,26 @@
-# contexts broker set
-
-## Overview
-
-Set a local broker address for the Sdk broker configuration
-
-**Aliases:** `set`
-
-**Usage:**
-
-```
-quix contexts broker set [<address>] [options]
-```
-
-**Arguments:**
-
-- `<address>` : The broker address for the Sdk broker configuration (ie: localhost:19092)
-
-**Options:**
-
+# contexts broker set
+
+## Overview
+
+Set a local broker address for the Sdk broker configuration
+
+**Aliases:** `set`
+
+**Usage:**
+
+```
+quix contexts broker set [<address>] [options]
+```
+
+**Arguments:**
+
+- `<address>` : The broker address for the Sdk broker configuration (ie: localhost:19092)
+
+**Options:**
+
 - `--enable` : Enables Local broker as Sdk broker configuration
 - `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
 - `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
 - `--directory <directory>` : Base directory (defaults to current directory)
-- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration []
-
+- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration []
+

docs/Reference/contexts/create.gen.md

@@ -1,25 +1,25 @@
-# contexts create
-
-## Overview
-
-Add a new context to the CLI
-
-**Aliases:** `create`, `add`
-
-**Usage:**
-
-```
-quix contexts create [<name>] [options]
-```
-
-**Arguments:**
-
-- `<name>` : Name of the context
-
-**Options:**
-
+# contexts create
+
+## Overview
+
+Add a new context to the CLI
+
+**Aliases:** `create`, `add`
+
+**Usage:**
+
+```
+quix contexts create [<name>] [options]
+```
+
+**Arguments:**
+
+- `<name>` : Name of the context
+
+**Options:**
+
 - `-e, --endpoint <endpoint>` : Portal endpoint
 - `-b, --sdk-broker-address <sdk-broker-address>` : Sdk broker configuration address
 - `-c, --use-quix-cloud-broker` : Set the Sdk broker configuration to the one in your Quix Cloud environment
-- `-l, --use-local-broker` : Set the Sdk broker configuration to one accessible from your local machine
-
+- `-l, --use-local-broker` : Set the Sdk broker configuration to one accessible from your local machine
+

docs/Reference/contexts/environments/use.gen.md

@@ -1,18 +1,18 @@
-# contexts environments use
-
-## Overview
-
-Select the default environment for the current context
-
-**Aliases:** `use`
-
-**Usage:**
-
-```
-quix contexts environments use [<workspace-id>] [options]
-```
-
-**Arguments:**
-
-- `<workspace-id>` : The ID of the environment to set as default
-
+# contexts environments use
+
+## Overview
+
+Select the default environment for the current context
+
+**Aliases:** `use`
+
+**Usage:**
+
+```
+quix contexts environments use [<workspace-id>] [options]
+```
+
+**Arguments:**
+
+- `<workspace-id>` : The ID of the environment to set as default
+

docs/Reference/contexts/index.gen.md

@@ -14,11 +14,11 @@ quix contexts [command] [options]
 
 **Commands:**
 
-- [broker](broker\index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
+- [broker](broker/index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
 - [create](create.md) : Add a new context to the CLI
 - [current](current.md) : Gets information about the current context
 - [delete](delete.md) : Remove a context from the CLI
-- [environments](environments\index.md) : Manage the default environment
+- [environments](environments/index.md) : Manage the default environment
 - [list](list.md) : Get all contexts
 - [reset](reset.md) : Resets your context to defaults
 - [use](use.md) : Uses the specified context

docs/Reference/login.gen.md

@@ -1,18 +1,18 @@
-# login
-
-## Overview
-
-Login to your Quix Cloud account
-
-**Aliases:** `login`
-
-**Usage:**
-
-```
-quix login [<pat>] [options]
-```
-
-**Arguments:**
-
-- `<pat>` : Personal Access Token, if not specified it will do interactive login
-
+# login
+
+## Overview
+
+Login to your Quix Cloud account
+
+**Aliases:** `login`
+
+**Usage:**
+
+```
+quix login [<pat>] [options]
+```
+
+**Arguments:**
+
+- `<pat>` : Personal Access Token, if not specified it will do interactive login
+

docs/Reference/pipeline/index.gen.md

@@ -15,8 +15,8 @@ quix pipeline [command] [options]
 **Commands:**
 
 - [view](view.md) : Create and preview a mermaid diagram of the pipeline
-- [broker](broker\index.md) : Manage the broker instance of the local pipeline
-- [deployments](deployments\index.md) : Manage the deployments of the local pipeline
+- [broker](broker/index.md) : Manage the broker instance of the local pipeline
+- [deployments](deployments/index.md) : Manage the deployments of the local pipeline
 - [status](status.md) : Display the current status of the local pipeline
 - [update](update.md) : Update 'quix.yaml' with the new local applications and update the variables of the existing deployments
 - [sync](sync.md) : Synchronize your local pipeline to Quix Cloud

docs/Reference/sdk/index.gen.md

@@ -14,5 +14,5 @@ quix sdk [command] [options]
 
 **Commands:**
 
-- [broker](broker\index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
+- [broker](broker/index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
 

docs/Reference/status.gen.md

@@ -1,18 +1,18 @@
-# status
-
-## Overview
-
-Get a global status check of the settings, dependencies and services managed by the CLI
-
-**Aliases:** `status`
-
-**Usage:**
-
-```
-quix status [options]
-```
-
-**Options:**
-
-- `--directory <directory>` : If specified, it will use that directory instead of the current one
-
+# status
+
+## Overview
+
+Get a global status check of the settings, dependencies and services managed by the CLI
+
+**Aliases:** `status`
+
+**Usage:**
+
+```
+quix status [options]
+```
+
+**Options:**
+
+- `--directory <directory>` : If specified, it will use that directory instead of the current one
+

docs/Reference/use.gen.md

@@ -1,18 +1,18 @@
-# use
-
-## Overview
-
-Select the default environment for the current context
-
-**Aliases:** `use`
-
-**Usage:**
-
-```
-quix use [<workspace-id>] [options]
-```
-
-**Arguments:**
-
-- `<workspace-id>` : The ID of the environment to set as default
-
+# use
+
+## Overview
+
+Select the default environment for the current context
+
+**Aliases:** `use`
+
+**Usage:**
+
+```
+quix use [<workspace-id>] [options]
+```
+
+**Arguments:**
+
+- `<workspace-id>` : The ID of the environment to set as default
+