From 59fb14c61c0e21351b55030cf0d878d3e09e41f0 Mon Sep 17 00:00:00 2001 From: Mahmoud Mabrouk Date: Mon, 31 Jul 2023 12:07:59 +0200 Subject: [PATCH 01/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 689274c523..b6cf6436a7 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ https://github.com/Agenta-AI/agenta/assets/4510758/f8a2a423-c0a9-40df-9c00-52908 We warmly welcome contributions to Agenta. Feel free to submit issues, fork the repository, and send pull requests. -Check out our [Contributing Guide](https://docs.agenta.ai/docs/contributing/getting-started) for more information. +Check out our [Contributing Guide](https://docs.agenta.ai/contributing/getting-started) for more information. ## Contributors ✨ From 4fc56d7a6d97f3a51e2cbcbf6c323c865b87d186 Mon Sep 17 00:00:00 2001 From: Sameh Methnani <57623556+SamMethnani@users.noreply.github.com> Date: Mon, 31 Jul 2023 13:02:45 +0200 Subject: [PATCH 02/11] Update getting-started.mdx --- docs/contributing/getting-started.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/getting-started.mdx b/docs/contributing/getting-started.mdx index bcb4a62e59..74c170de8c 100644 --- a/docs/contributing/getting-started.mdx +++ b/docs/contributing/getting-started.mdx @@ -7,11 +7,11 @@ Hello, thank you for your interest in contributing to our project. We value your ## Getting Started -1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/docs/installation/local-installation/local-installation). +1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). -2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/docs/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/docs/conceptual/architecture) to understand the underlying principles and architecture of our project. +2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture) to understand the underlying principles and architecture of our project. -3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/docs/contributing/development-mode). +3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode). ## Contribution Steps From 9446c485f080eccd589e9f8e7fbe430791110de6 Mon Sep 17 00:00:00 2001 From: Sameh Methnani <57623556+SamMethnani@users.noreply.github.com> Date: Mon, 31 Jul 2023 13:04:39 +0200 Subject: [PATCH 03/11] Update local-installation.mdx --- docs/installation/local-installation/local-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/local-installation/local-installation.mdx b/docs/installation/local-installation/local-installation.mdx index 37b7813199..1122d886f4 100644 --- a/docs/installation/local-installation/local-installation.mdx +++ b/docs/installation/local-installation/local-installation.mdx @@ -23,7 +23,7 @@ To install the SDK and CLI, you can use pip: pip install agenta ``` -Please see [contributing](/docs/contributing/development-mode) for more information on how to install the SDK and CLI for developement. +Please see [contributing](/contributing/development-mode) for more information on how to install the SDK and CLI for developement. ## Installing the web platform From 2c8d0d3a964355fd77a0d1c652743471bedf95ce Mon Sep 17 00:00:00 2001 From: Sameh Methnani Date: Mon, 31 Jul 2023 13:16:48 +0200 Subject: [PATCH 04/11] update links in docs --- CONTRIBUTING.md | 6 +++--- agenta-cli/agenta/templates/simple_prompt/README.md | 2 +- agenta-web/src/components/Playground/Views/TestView.tsx | 2 +- docs/getting-started.mdx | 2 +- examples/job_classifier/README.md | 2 +- examples/sales_transcript_summarizer/README.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ee25f58f6..d15b6404d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ Hello, thank you for your interest in contributing to our project. We value your ## Getting Started -1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/docs/installation/local-installation/local-installation). +1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). -2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/docs/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/docs/conceptual/architecture) to understand the underlying principles and architecture of our project. +2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture) to understand the underlying principles and architecture of our project. -3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/docs/contributing/development-mode). +3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode). ## Contribution Steps diff --git a/agenta-cli/agenta/templates/simple_prompt/README.md b/agenta-cli/agenta/templates/simple_prompt/README.md index 252342f10a..757455e2ca 100644 --- a/agenta-cli/agenta/templates/simple_prompt/README.md +++ b/agenta-cli/agenta/templates/simple_prompt/README.md @@ -6,4 +6,4 @@ OPENAI_API_KEY=sk-xxxxxxx You can find your keys here: https://platform.openai.com/account/api-keys -Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue \ No newline at end of file +Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue \ No newline at end of file diff --git a/agenta-web/src/components/Playground/Views/TestView.tsx b/agenta-web/src/components/Playground/Views/TestView.tsx index b2f71ac2b2..9ca0596e7e 100644 --- a/agenta-web/src/components/Playground/Views/TestView.tsx +++ b/agenta-web/src/components/Playground/Views/TestView.tsx @@ -57,7 +57,7 @@ const BoxComponent: React.FC = ({ setResults( "The code has resulted in the following error: \n\n --------------------- \n" + e + - "\n---------------------\n\nPlease update your code, and re-serve it using cli and try again.\n\nFor more information please read https://docs.agenta.ai/docs/howto/how-to-debug\n\nIf you believe this is a bug, please create a new issue here: https://github.com/Agenta-AI/agenta/issues/new?title=Issue%20in%20playground", + "\n---------------------\n\nPlease update your code, and re-serve it using cli and try again.\n\nFor more information please read https://docs.agenta.ai/howto/how-to-debug\n\nIf you believe this is a bug, please create a new issue here: https://github.com/Agenta-AI/agenta/issues/new?title=Issue%20in%20playground", ) } } diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 0131a72324..aa1d28e162 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -22,7 +22,7 @@ mkdir example_app; cd example_app agenta init ``` -Next, start a new project based on the `simple_prompt` [template](https://docs.agenta.ai/docs/conceptual/concepts#templates) +Next, start a new project based on the `simple_prompt` [template](https://docs.agenta.ai/conceptual/concepts#templates) ```` ? Please enter the app name: company_name_generator diff --git a/examples/job_classifier/README.md b/examples/job_classifier/README.md index 252342f10a..757455e2ca 100644 --- a/examples/job_classifier/README.md +++ b/examples/job_classifier/README.md @@ -6,4 +6,4 @@ OPENAI_API_KEY=sk-xxxxxxx You can find your keys here: https://platform.openai.com/account/api-keys -Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue \ No newline at end of file +Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue \ No newline at end of file diff --git a/examples/sales_transcript_summarizer/README.md b/examples/sales_transcript_summarizer/README.md index 88d0292e3c..57a63ea29f 100644 --- a/examples/sales_transcript_summarizer/README.md +++ b/examples/sales_transcript_summarizer/README.md @@ -5,7 +5,7 @@ OPENAI_API_KEY=sk-xxxxxxx You can find your keys [here](https://platform.openai.com/account/api-keys) -Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue +Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue ## Example Prompts From aacf1f23da99eaee1ced78e8a4a1838574bc0bc3 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 31 Jul 2023 11:19:50 +0000 Subject: [PATCH 05/11] docs: update README.md [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b6cf6436a7..50c0d42d43 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d - + From 2b1554f4e69f0b49c9673b3f0ef5354ec3b3d3c2 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 31 Jul 2023 11:19:51 +0000 Subject: [PATCH 06/11] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 0977df411c..0c5cbfa38c 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -13,7 +13,8 @@ "avatar_url": "https://avatars.githubusercontent.com/u/57623556?v=4", "profile": "https://github.com/SamMethnani", "contributions": [ - "code" + "code", + "doc" ] }, { From be607acc6e5dc71e8a0c5092632ba1be1ac2e9ad Mon Sep 17 00:00:00 2001 From: Sameh Methnani Date: Mon, 31 Jul 2023 13:23:06 +0200 Subject: [PATCH 07/11] updating links in docs --- docs/getting-started.mdx | 4 ++-- docs/howto/creating-multiple-app-variants.mdx | 2 +- docs/tutorials/your-first-llm-app.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index aa1d28e162..9f34a20a14 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -7,11 +7,11 @@ description: 'Building your first Large Language Model Application in Agenta' Welcome! In this beginner-friendly guide, we'll walk through the process of building a simple LLM app in Agenta, using an existing template. By the end of this tutorial, you'll have your first working LLM app and a good understanding of how to interact with Agenta. -To learn more about creating an LLM app from scratch, please visit our [advanced tutorial](/docs/tutorials/your-first-llm-app). +To learn more about creating an LLM app from scratch, please visit our [advanced tutorial](/tutorials/your-first-llm-app). ## Prerequisites -Ensure you have installed the Agenta CLI and SDK, and have set up the web platform using docker-compose. If you haven't done this, follow the steps in our [installation guide](/docs/installation). +Ensure you have installed the Agenta CLI and SDK, and have set up the web platform using docker-compose. If you haven't done this, follow the steps in our [installation guide](/installation). ## Step 1: Initialize a New Project diff --git a/docs/howto/creating-multiple-app-variants.mdx b/docs/howto/creating-multiple-app-variants.mdx index 4d728f315e..79b295f7f0 100644 --- a/docs/howto/creating-multiple-app-variants.mdx +++ b/docs/howto/creating-multiple-app-variants.mdx @@ -4,7 +4,7 @@ title: Creating Multiple App Variants ## How to Create Multiple App Variants in a Single Project -This guide provides instructions on creating multiple variants within one project. A "variant" is a unique version of your app that may feature a different architecture or significant changes in the codebase. (See [the concept guide](/docs/conceptual/concepts#app-variant) for more details on variants.) +This guide provides instructions on creating multiple variants within one project. A "variant" is a unique version of your app that may feature a different architecture or significant changes in the codebase. (See [the concept guide](/conceptual/concepts#app-variant) for more details on variants.) ## Ways to Create App Variants diff --git a/docs/tutorials/your-first-llm-app.mdx b/docs/tutorials/your-first-llm-app.mdx index 94bf68dab7..2c0be8b46e 100644 --- a/docs/tutorials/your-first-llm-app.mdx +++ b/docs/tutorials/your-first-llm-app.mdx @@ -9,7 +9,7 @@ Let's begin. ## Prerequisites -This guide assumes you have completed the installation process. If not, please follow our [installation guide](/docs/installation). +This guide assumes you have completed the installation process. If not, please follow our [installation guide](/installation). ## 1. Project Initialization From 8eef019106a09add512b51233889d98114f103fa Mon Sep 17 00:00:00 2001 From: isra el Date: Mon, 31 Jul 2023 21:06:00 +0300 Subject: [PATCH 08/11] Update sidebar menu items to allow opening in new tab --- agenta-web/src/components/Sidebar/Sidebar.tsx | 30 ++++++++----------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/agenta-web/src/components/Sidebar/Sidebar.tsx b/agenta-web/src/components/Sidebar/Sidebar.tsx index 12548d2160..edbec33820 100644 --- a/agenta-web/src/components/Sidebar/Sidebar.tsx +++ b/agenta-web/src/components/Sidebar/Sidebar.tsx @@ -16,6 +16,7 @@ import { import {Avatar, Layout, Menu, Space, Tag, Tooltip, theme} from "antd" import Logo from "../Logo/Logo" +import Link from 'next/link' const {Sider} = Layout @@ -44,11 +45,11 @@ const Sidebar: React.FC = () => { setSelectedKeys(initialSelectedKeys) }, [page_name]) - const navigate = (path: string) => { + const getNavigationPath = (path: string) => { if (path === "apps") { - router.push(`/apps`) + return '/apps' } else { - router.push(`/apps/${app_name}/${path}`) + return `/apps/${app_name}/${path}` } } @@ -79,13 +80,12 @@ const Sidebar: React.FC = () => { } - onClick={() => navigate("apps")} > -
App Management
+ App Management {page_name && ( @@ -93,68 +93,63 @@ const Sidebar: React.FC = () => { } - onClick={() => navigate("playground")} > -
Playground
+ Playground } - onClick={() => navigate("testsets")} > -
Test Sets
+ Test Sets } - onClick={() => navigate("evaluations")} > -
Evaluate
+ Evaluate } - onClick={() => navigate("results")} > -
Results
+ Results } - onClick={() => navigate("endpoints")} > -
+ Endpoints -
+ @@ -171,9 +166,8 @@ const Sidebar: React.FC = () => { } - onClick={() => window.open("https://docs.agenta.ai", "_blank")} > - Help + Help {/* From 6635ff1841b172b2e30efc8b6e25c243fe05f7d2 Mon Sep 17 00:00:00 2001 From: isra el Date: Mon, 31 Jul 2023 21:21:43 +0300 Subject: [PATCH 09/11] fix docs url --- agenta-web/src/components/Sidebar/Sidebar.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agenta-web/src/components/Sidebar/Sidebar.tsx b/agenta-web/src/components/Sidebar/Sidebar.tsx index edbec33820..633b1c69c4 100644 --- a/agenta-web/src/components/Sidebar/Sidebar.tsx +++ b/agenta-web/src/components/Sidebar/Sidebar.tsx @@ -167,7 +167,7 @@ const Sidebar: React.FC = () => { key="help" icon={} > - Help + Help {/* From 7a4d752f6863465eeab7c5dabf3eed01b9f64b7e Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 31 Jul 2023 18:49:50 +0000 Subject: [PATCH 10/11] docs: update README.md [skip ci] --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50c0d42d43..9f5affaf44 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ Check out our [Contributing Guide](https://docs.agenta.ai/contributing/getting-s ## Contributors ✨ -[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-) Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -128,6 +128,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d +
Sameh Methnani
Sameh Methnani
💻		Sameh Methnani
Sameh Methnani
💻 📖		 Suad Suljovic
Suad Suljovic
💻 🎨		 burtenshaw
burtenshaw
💻		 Abram
Abram
💻 📖		Suad Suljovic
Suad Suljovic
💻 🎨		 burtenshaw
burtenshaw
💻		 Abram
Abram
💻 📖		Israel Abebe
Israel Abebe
🐛
From 5e54480c666db7bb9304f3d7e4cd6faefd76a17e Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 31 Jul 2023 18:49:51 +0000 Subject: [PATCH 11/11] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 0c5cbfa38c..cea8fdc80c 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -45,6 +45,15 @@ "code", "doc" ] + }, + { + "login": "vernu", + "name": "Israel Abebe", + "avatar_url": "https://avatars.githubusercontent.com/u/7479824?v=4", + "profile": "http://israelabebe.com", + "contributions": [ + "bug" + ] } ], "contributorsPerLine": 7,