Merge pull request #1631 from Agenta-AI/docs/restructure

Restructure docs
Agenta-AI · May 10, 2024 · d060420 · d060420
2 parents 9b2bb66 + 4c84350
commit d060420
Show file tree

Hide file tree

Showing 107 changed files with 272 additions and 160 deletions.
diff --git a/docs/advanced_guides/using_custom_evaluators.mdx b/docs/advanced_guides/using_custom_evaluators.mdx
diff --git a/docs/depractated/quickstart/installation.mdx b/docs/depractated/quickstart/installation.mdx
@@ -28,7 +28,7 @@ Use pip to install the SDK and CLI easily:
 pip install agenta
 ```
 
-<Info>Please see [contributing](/developer_guides/contributing/development-mode) for more information on how to install the SDK and CLI in developement mode.</Info>
+<Info>Please see [contributing](/misc/contributing/development-mode) for more information on how to install the SDK and CLI in developement mode.</Info>
 
 <Tip>Agenta is under continuous developement, don't forget to always upgrade to the latest version of agenta using `pip install -U agenta`.</Tip>
 
@@ -57,6 +57,6 @@ Open your browser and go to [http://localhost](http://localhost). If you see the
 ## What's next?
 You're all set to start using Agenta!
 
-<Card title="Well Done!" icon="check" iconType="duotone" color="#29B772" href="/getting_started/getting-started-ui">
+<Card title="Well Done!" icon="check" iconType="duotone" color="#29B772" href="/getting_started/quick_start">
 Click here to build your first LLM app in just 1 minute.
 </Card>
diff --git a/docs/basic_guides/automatic_evaluation.mdx → docs/evaluation/automatic_evaluation.mdx b/docs/basic_guides/automatic_evaluation.mdx → docs/evaluation/automatic_evaluation.mdx
diff --git a/docs/basic_guides/custom_evaluator.mdx → docs/evaluation/custom_evaluator.mdx b/docs/basic_guides/custom_evaluator.mdx → docs/evaluation/custom_evaluator.mdx
diff --git a/docs/basic_guides/human_evaluation.mdx → docs/evaluation/human_evaluation.mdx b/docs/basic_guides/human_evaluation.mdx → docs/evaluation/human_evaluation.mdx
diff --git a/docs/evaluation/overview.mdx b/docs/evaluation/overview.mdx
diff --git a/docs/basic_guides/test_sets.mdx → docs/evaluation/test_sets.mdx b/docs/basic_guides/test_sets.mdx → docs/evaluation/test_sets.mdx
diff --git a/docs/getting_started/introduction.mdx b/docs/getting_started/introduction.mdx
@@ -9,12 +9,12 @@ Agenta is an open-source platform that helps **developers** and **product teams*
 
 ### With Agenta, you can:
 
-1. Rapidly [**experiment** and **compare** prompts](/basic_guides/prompt_engineering) on [any LLM workflow](/advanced_guides/custom_applications) (chain-of-prompts, Retrieval Augmented Generation (RAG), LLM agents...) 
-2. Rapidly [**create test sets**](/basic_guides/test_sets) and **golden datasets** for evaluation
+1. Rapidly [**experiment** and **compare** prompts](/prompt_management/prompt_engineering) on [any LLM workflow](/prompt_management/custom_applications) (chain-of-prompts, Retrieval Augmented Generation (RAG), LLM agents...) 
+2. Rapidly [**create test sets**](/evaluation/test_sets) and **golden datasets** for evaluation
 3. **Evaluate** your application with pre-existing or **custom evaluators**
 4. **Annotate** and **A/B test** your applications with **human feedback**
-5. [**Collaborate with product teams**](/basic_guides/team_management) for prompt engineering and evaluation
-6. [**Deploy your application**](/basic_guides/deployment) in one-click in the UI,  through CLI, or through github workflows. 
+5. [**Collaborate with product teams**](/misc/team_management) for prompt engineering and evaluation
+6. [**Deploy your application**](/prompt_management/deployment) in one-click in the UI,  through CLI, or through github workflows. 
 
 Agenta focuses on increasing the speed of the development cycle of LLM applications by increasing the speed of experimentation.
 
@@ -23,7 +23,7 @@ Agenta focuses on increasing the speed of the development cycle of LLM applicati
 ### Works with any LLM app workflow
 Agenta enables prompt engineering and evaluation on any LLM app architecture, such as **Chain of Prompts**, **RAG**, or **LLM agents**. It is compatible with any framework like **Langchain** or **LlamaIndex**, and works with any model provider, such as **OpenAI**, **Cohere**, or **local models**.
 
-[Jump here](/advanced_guides/custom_applications) to see how to use your own custom application with Agenta and [here](/developer_guides/how_does_agenta_work) to understand more how Agenta works.
+[Jump here](/prompt_management/custom_applications) to see how to use your own custom application with Agenta and [here](/guides/how_does_agenta_work) to understand more how Agenta works.
 
 ### Enable collaboration between developers and product teams
 
@@ -39,7 +39,7 @@ By **adding a few lines to your application code**, you can create a prompt play
   <Card
     title="Get Started"
     icon="stars"
-    href="/getting_started/getting-started-ui"
+    href="/getting_started/quick-start"
     color="#33FF57">
       Create and deploy your first app from the UI in under 2 minutes.
   </Card>
@@ -48,7 +48,7 @@ By **adding a few lines to your application code**, you can create a prompt play
     title="Create a Custom App"
     icon="code"
     color="#337BFF"
-    href="/advanced_guides/custom_applications">
+    href="/prompt_management/custom_applications">
       Write a custom LLM app and evaluate it in 10 minutes.
   </Card>
 

diff --git a/docs/getting_started/getting-started-ui.mdx → docs/getting_started/quick-start.mdx b/docs/getting_started/getting-started-ui.mdx → docs/getting_started/quick-start.mdx
@@ -3,7 +3,7 @@ title: 'Quick Start'
 description: 'Create and deploy your first LLM app in one minute'
 ---
 
-<Note>This tutorial helps users create LLM apps using templates within the UI. For more complex applications involving code in Agenta, please refer to Using code in Agenta [Using code in agenta](/advanced_guides/custom_applications) </Note>
+<Note>This tutorial helps users create LLM apps using templates within the UI. For more complex applications involving code in Agenta, please refer to Using code in Agenta [Using code in agenta](/prompt_management/custom_applications) </Note>
 
 Want a video tutorial instead? We have a 4-minute video for you. [Watch it here](https://youtu.be/plPVrHXQ-DU).
 
@@ -57,4 +57,4 @@ You can now find the API endpoint in the "Endpoints" menu. Copy and paste the co
 <img height="600" src="/images/getting-started-ui-screenshots/06_deployment.png" />
 
 
-<Check> Congratulations! You've created your first LLM application. Feel free to modify it, explore its parameters, and discover Agenta's features. Your next steps could include [building an application using your own code](/advanced_guides/custom_applications), or following one of our UI-based tutorials.</Check> 
+<Check> Congratulations! You've created your first LLM application. Feel free to modify it, explore its parameters, and discover Agenta's features. Your next steps could include [building an application using your own code](/prompt_management/custom_applications), or following one of our UI-based tutorials.</Check> 
diff --git a/docs/cookbook/extract_job_information.mdx → docs/guides/extract_job_information.mdx b/docs/cookbook/extract_job_information.mdx → docs/guides/extract_job_information.mdx
diff --git a/...developer_guides/how_does_agenta_work.mdx → docs/guides/how_does_agenta_work.mdx b/...developer_guides/how_does_agenta_work.mdx → docs/guides/how_does_agenta_work.mdx
diff --git a/docs/cookbook/list_templates.mdx → docs/guides/list_templates.mdx b/docs/cookbook/list_templates.mdx → docs/guides/list_templates.mdx
@@ -1,21 +1,21 @@
 ---
-title: "Templates by Architecture"
+title: "Overview"
 description: "A collection of templates and tutorials indexed by architecture."
 ---
 
 # Tutorials
 ## 📝 Text Generation
-### [Single Prompt Application using OpenAI and Langchain](/developer_guides/tutorials/first-app-with-langchain)
+### [Single Prompt Application using OpenAI and Langchain](/guides/tutorials/first-app-with-langchain)
 <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Text Generation </span> <span>&nbsp;</span> <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> OpenAI </span> <span>&nbsp;</span>  <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Langchain </span><span>&nbsp;</span>
 
 Learn how to use our SDK to deploy an application with agenta. The application we will create uses OpenAI and Langchain. The application generates outreach messages in Linkedin to investors based on a startup name and idea. 
-### [Use Mistral from Huggingface for a Summarization Task](/developer_guides/tutorials/deploy-mistral-model)
+### [Use Mistral from Huggingface for a Summarization Task](/guides/tutorials/deploy-mistral-model)
 <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Text Generation </span> <span>&nbsp;</span> <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Mistral </span> <span>&nbsp;</span>  <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Hugging Face </span><span>&nbsp;</span>
 
 Learn how to use a custom model with agenta.
 
 ## Retrieval Augmented Generation (RAG)
-### [RAG Application with LlamaIndex](/developer_guides/tutorials/build-rag-application)
+### [RAG Application with LlamaIndex](/guides/tutorials/build-rag-application)
 <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Sales </span> <span>&nbsp;</span> <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> OpenAI </span> <span>&nbsp;</span>  <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> RAG </span><span>&nbsp;</span><span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> LlamaIndex </span>
 
 Learn how to create a RAG application with LlamaIndex and use it in agenta. You will create a playground in agenta where you can experiment with the parameters of the RAG application, test it and compare different versions.
@@ -24,7 +24,7 @@ Learn how to create a RAG application with LlamaIndex and use it in agenta. You
 ## ⛏️ Extraction
 
 These templates extract data in a structured format from an unstructured source.
-### [Extraction using OpenAI Functions and Langchain](/cookbook/extract_job_information)
+### [Extraction using OpenAI Functions and Langchain](/guides/extract_job_information)
 
 <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> HR </span> <span>&nbsp;</span> <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> OpenAI </span> <span>&nbsp;</span>  <span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Functions </span><span>&nbsp;</span><span style={{ backgroundColor: '#FEF0F0', color: '#DC2626'}}> Langchain </span>
 

diff --git a/...als/a-more-complicated-tutorial-draft.mdx → ...als/a-more-complicated-tutorial-draft.mdx b/...als/a-more-complicated-tutorial-draft.mdx → ...als/a-more-complicated-tutorial-draft.mdx
diff --git a/...uides/tutorials/build-rag-application.mdx → ...uides/tutorials/build-rag-application.mdx b/...uides/tutorials/build-rag-application.mdx → ...uides/tutorials/build-rag-application.mdx
diff --git a/...guides/tutorials/deploy-mistral-model.mdx → ...guides/tutorials/deploy-mistral-model.mdx b/...guides/tutorials/deploy-mistral-model.mdx → ...guides/tutorials/deploy-mistral-model.mdx
diff --git a/...es/tutorials/first-app-with-langchain.mdx → ...es/tutorials/first-app-with-langchain.mdx b/...es/tutorials/first-app-with-langchain.mdx → ...es/tutorials/first-app-with-langchain.mdx
diff --git a/docs/images/prompt_management/asapromptmanagement.png b/docs/images/prompt_management/asapromptmanagement.png
diff --git a/docs/images/prompt_management/asaproxy.png b/docs/images/prompt_management/asaproxy.png