Merge branch 'main' of https://github.com/Agenta-AI/agenta-core

Agenta-AI · Jul 31, 2023 · f8dcc86 · f8dcc86
2 parents 9b2764a + 91c1b94
commit f8dcc86
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 38 deletions.
diff --git 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"
       ]
     },
     {
@@ -44,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,

diff --git 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/README.md b/README.md
@@ -108,12 +108,12 @@ 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 ✨
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![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-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -124,10 +124,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/SamMethnani"><img src="https://avatars.githubusercontent.com/u/57623556?v=4?s=100" width="100px;" alt="Sameh Methnani"/><br /><sub><b>Sameh Methnani</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/commits?author=SamMethnani" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/SamMethnani"><img src="https://avatars.githubusercontent.com/u/57623556?v=4?s=100" width="100px;" alt="Sameh Methnani"/><br /><sub><b>Sameh Methnani</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/commits?author=SamMethnani" title="Code">💻</a> <a href="https://github.com/Agenta-AI/agenta/commits?author=SamMethnani" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/suadsuljovic"><img src="https://avatars.githubusercontent.com/u/8658374?v=4?s=100" width="100px;" alt="Suad Suljovic"/><br /><sub><b>Suad Suljovic</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/commits?author=suadsuljovic" title="Code">💻</a> <a href="#design-suadsuljovic" title="Design">🎨</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/burtenshaw"><img src="https://avatars.githubusercontent.com/u/19620375?v=4?s=100" width="100px;" alt="burtenshaw"/><br /><sub><b>burtenshaw</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/commits?author=burtenshaw" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://abram.tech"><img src="https://avatars.githubusercontent.com/u/55067204?v=4?s=100" width="100px;" alt="Abram"/><br /><sub><b>Abram</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/commits?author=aybruhm" title="Code">💻</a> <a href="https://github.com/Agenta-AI/agenta/commits?author=aybruhm" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://israelabebe.com"><img src="https://avatars.githubusercontent.com/u/7479824?v=4?s=100" width="100px;" alt="Israel Abebe"/><br /><sub><b>Israel Abebe</b></sub></a><br /><a href="https://github.com/Agenta-AI/agenta/issues?q=author%3Avernu" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

diff --git 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
+Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue
diff --git 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<BoxComponentProps> = ({
             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/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,82 +80,76 @@ const Sidebar: React.FC = () => {
                     <Menu.Item
                         key="apps"
                         icon={<AppstoreOutlined />}
-                        onClick={() => navigate("apps")}
                     >
                         <Tooltip
                             placement="right"
                             title="Create new applications or switch between your existing projects."
                         >
-                            <div style={{width: "100%"}}>App Management</div>
+                            <Link href={getNavigationPath('apps')} style={{width: "100%"}}>App Management</Link>
                         </Tooltip>
                     </Menu.Item>
                     {page_name && (
                         <>
                             <Menu.Item
                                 key="playground"
                                 icon={<RocketOutlined />}
-                                onClick={() => navigate("playground")}
                             >
                                 <Tooltip
                                     placement="right"
                                     title="Experiment with real data and optimize your parameters including prompts, methods, and configuration settings."
                                 >
-                                    <div style={{width: "100%"}}>Playground</div>
+                                    <Link href={getNavigationPath('playground')} style={{width: "100%"}}>Playground</Link>
                                 </Tooltip>
                             </Menu.Item>
 
                             <Menu.Item
                                 key="testsets"
                                 icon={<DatabaseOutlined />}
-                                onClick={() => navigate("testsets")}
                             >
                                 <Tooltip
                                     placement="right"
                                     title="Create and manage testsets for evaluation purposes."
                                 >
-                                    <div style={{width: "100%"}}>Test Sets</div>
+                                    <Link href={getNavigationPath('testsets')} style={{width: "100%"}}>Test Sets</Link>
                                 </Tooltip>
                             </Menu.Item>
 
                             <Menu.Item
                                 key="evaluations"
                                 icon={<LineChartOutlined />}
-                                onClick={() => navigate("evaluations")}
                             >
                                 <Tooltip
                                     placement="right"
                                     title="Perform 1-to-1 variant comparisons on testsets to identify superior options."
                                 >
-                                    <div style={{width: "100%"}}>Evaluate</div>
+                                    <Link href={getNavigationPath('evaluations')} style={{width: "100%"}}>Evaluate</Link>
                                 </Tooltip>
                             </Menu.Item>
                             <Menu.Item
                                 key="results"
                                 icon={<BarChartOutlined />}
-                                onClick={() => navigate("results")}
                             >
                                 <Tooltip
                                     placement="right"
                                     title="Analyze the evaluation outcomes to determine the most effective variants."
                                 >
-                                    <div style={{width: "100%"}}>Results</div>
+                                    <Link href={getNavigationPath('results')} style={{width: "100%"}}>Results</Link>
                                 </Tooltip>
                             </Menu.Item>
 
                             <Menu.Item
                                 key="endpoints"
                                 icon={<CloudUploadOutlined />}
-                                onClick={() => navigate("endpoints")}
                             >
                                 <Tooltip
                                     placement="right"
                                     title="Monitor production logs to ensure seamless operations."
                                 >
-                                    <div style={{width: "100%"}}>
+                                    <Link href={getNavigationPath('endpoints')} style={{width: "100%"}}>
                                         <Space>
                                             <span>Endpoints</span>
                                         </Space>
-                                    </div>
+                                    </Link>
                                 </Tooltip>
                             </Menu.Item>
                         </>
@@ -171,9 +166,8 @@ const Sidebar: React.FC = () => {
                     <Menu.Item
                         key="help"
                         icon={<QuestionOutlined />}
-                        onClick={() => window.open("https://docs.agenta.ai", "_blank")}
                     >
-                        Help
+                        <Link href='https://docs.agenta.ai' target='_blank'>Help</Link>
                     </Menu.Item>
                     {/* <Menu.Item key="user">
                         <Space>

diff --git 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
 

diff --git 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
 
@@ -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/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/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
 

diff --git 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
 

diff --git 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
+Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue
diff --git 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