From 078f69418a09d9576f6dce083c1264efe0d3b670 Mon Sep 17 00:00:00 2001 From: ashrafchowdury Date: Tue, 27 Aug 2024 14:20:48 +0600 Subject: [PATCH] fix: doc headings alignments --- website/docs/evaluation/test_sets.mdx | 4 ++-- website/docs/observability/quickstart.mdx | 4 ++-- website/docs/prompt_management/integrating.mdx | 4 ++-- website/docs/reference/cli/core_commands/init.mdx | 4 ++-- website/docs/reference/cli/core_commands/variant_list.mdx | 4 ++-- website/docs/reference/cli/core_commands/variant_remove.mdx | 4 ++-- website/docs/reference/cli/core_commands/variant_serve.mdx | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/website/docs/evaluation/test_sets.mdx b/website/docs/evaluation/test_sets.mdx index 09abce2cc6..abf0c7a8b9 100644 --- a/website/docs/evaluation/test_sets.mdx +++ b/website/docs/evaluation/test_sets.mdx @@ -2,12 +2,12 @@ title: "Test Sets" --- +# Creating a Test Set + This guide will help you create, edit, and use test sets effectively. Test sets in Agenta can be loaded in the playground, used in evaluations, or for conducting human evaluations/annotations. -# Creating a Test Set - You can create a test set in Agenta using various methods: the API, the UI, by uploading a CSV, or directly from the playground. ## Creating a Test Set from the Playground diff --git a/website/docs/observability/quickstart.mdx b/website/docs/observability/quickstart.mdx index 99a3e62d45..35d3d2b378 100644 --- a/website/docs/observability/quickstart.mdx +++ b/website/docs/observability/quickstart.mdx @@ -2,6 +2,8 @@ title: Quick Start --- +# Setting up telemetry + You can configure Agenta to capture all inputs, outputs, and other metadata from your LLM applications, regardless of whether they are hosted in Agenta or in your environment. Post instrumentation, Agenta provides a dashboard that offers an overview of your app's performance metrics over time, including request counts, average latency, and costs. @@ -17,8 +19,6 @@ Concepts of Telemetry: ::: -# Setting up telemetry - :::note When creating an application from the UI, tracing is enabled by default. No setup is required. Simply navigate to the observability view to see all diff --git a/website/docs/prompt_management/integrating.mdx b/website/docs/prompt_management/integrating.mdx index 0c31bbe107..a5b932dfba 100644 --- a/website/docs/prompt_management/integrating.mdx +++ b/website/docs/prompt_management/integrating.mdx @@ -9,11 +9,11 @@ Applications and prompts created in agenta can be integrated into your projects 1. **As a Prompt Management System:** Fetch the latest version of prompts/configurations from agenta. - + 2. **As a Middleware:** Use the applications hosted on agenta directly. - + ## Using agenta as Middleware diff --git a/website/docs/reference/cli/core_commands/init.mdx b/website/docs/reference/cli/core_commands/init.mdx index 341ade1f8c..2001c40178 100644 --- a/website/docs/reference/cli/core_commands/init.mdx +++ b/website/docs/reference/cli/core_commands/init.mdx @@ -3,12 +3,12 @@ title: "agenta init" description: "Initialize a new project" --- +# Description + ```bash agenta init ``` -# Description - The init command initializes a new agenta project. Users can define the application's name and select the agenta platform host (either local or cloud). This command creates a blank project in the backend and generates a config.toml file for configuration settings. diff --git a/website/docs/reference/cli/core_commands/variant_list.mdx b/website/docs/reference/cli/core_commands/variant_list.mdx index cbadf5a8e9..b659335e63 100644 --- a/website/docs/reference/cli/core_commands/variant_list.mdx +++ b/website/docs/reference/cli/core_commands/variant_list.mdx @@ -3,12 +3,12 @@ title: "agenta variant list" description: "List the variants for an application" --- +# Description + ```bash agenta variant list ``` -# Description - The `list` command displays all the variants of your app that are currently available in the backend. :::caution diff --git a/website/docs/reference/cli/core_commands/variant_remove.mdx b/website/docs/reference/cli/core_commands/variant_remove.mdx index 94ffae9aaa..85ca49ed81 100644 --- a/website/docs/reference/cli/core_commands/variant_remove.mdx +++ b/website/docs/reference/cli/core_commands/variant_remove.mdx @@ -3,12 +3,12 @@ title: "agenta variant remove" description: "Removes a variant from an app/project" --- +# Description + ```bash agenta variant remove ``` -# Description - `variant remove` removes a variant from an app/project. It is called without any argument. The list of variants in the app/project is displayed and the user is prompted to select one of them to remove. :::caution diff --git a/website/docs/reference/cli/core_commands/variant_serve.mdx b/website/docs/reference/cli/core_commands/variant_serve.mdx index fe44307c0d..d3b2e3aa8f 100644 --- a/website/docs/reference/cli/core_commands/variant_serve.mdx +++ b/website/docs/reference/cli/core_commands/variant_serve.mdx @@ -3,12 +3,12 @@ title: "agenta variant serve" description: "Serve an application to the agenta platform" --- +# Description + ```bash agenta variant serve app_name.py ``` -# Description - The `serve` command deploys the code of an app to the agenta platform. The command packages the code in the .py file along with any additional files in the same directory and deploy them on the agenta platform. Once deployed, the variant becomes accessible the web UI. It can ehtn be further deployed to a staging or production environment as an API endpoint. In the agenta UI, the deployed variant is initially named `app_name.default` where `app_name` is the name of the python file deployed and `default` the default configuration. Creating a new configuration `someconfig` (either from the UI or from CLI), will result in the creation of corresponding new variant, named `app_name.someconfig`.