Merge pull request agentstack-ai#93 from AgentOps-AI/templates-documentation

Template Documentation

Author: bboynton97

README.md

@@ -11,7 +11,7 @@ AgentStack works on macOS, Windows, and Linux.<br>
 If something doesn't work, please [file an issue](https://github.com/agentops-ai/agentstack/issues/new).<br>
 If you have questions or need help, please ask in our [Discord community](https://discord.gg/JdWkh9tgTQ).
 
-> 🛠️🚨 AgentStack is in open preview. We're building in public, use at your own risk but have fun :)
+> 🛠️🏃🏼‍♀️ The quickest way to build your powerful agent project
 
 AgentStack serves as a great tool for starting your agent project and offers many CLI utilities for easy code-gen throughout the development process.
 
@@ -38,13 +38,13 @@ Create a project, and you're good to go.
 
 ## Creating an Agent Project
 
-**You'll need to have Python 3.10+ on your local development machine** (but it's not required on the server). We recommend using the latest version. You can use [pyenv](https://github.com/pyenv/pyenv) to switch Python versions between different projects.
+**You'll need to have Python 3.10+ on your local development machine**. We recommend using the latest version. You can use [pyenv](https://github.com/pyenv/pyenv) to switch Python versions between different projects.
 
 To create a new agent project, run:
 
 ```sh
 pip install agentstack
-agentstack init
+agentstack init <project_name>
 ```
 
 It will create a directory with your project name inside the current folder.<br>
@@ -54,9 +54,12 @@ No configuration or complicated folder structures, only the files you need to bu
 Once the initialization is done, you can open your project folder:
 
 ```sh
-cd my-agent-project
+cd <your_agent_project>
 ```
 
+### Templates
+Additionally, pre-built templates are available as a shortcut to building your project. [View the available templates]().
+
 ## Building Agent Functionality
 
 After generating a project, the next step is to build your agent project by creating Agents and Tasks. You can do this quickly with AgentStack:
@@ -101,13 +104,9 @@ AgentStack is not designed to be a low-code solution to building agents. Instead
 
 ## Roadmap
 
-### Frameworks
-
-#### CrewAI
-Development of AgentStack is being done primarily on [CrewAI](https://crewai.com).
+### Framework Agnosticism
 
-#### AutoGen
-Some work has been done to add Microsoft's [AutoGen](https://microsoft.github.io/autogen/0.2/), although these efforts have been paused. AutoGen is currently in the process of making [large design decisions](https://microsoft.github.io/autogen/dev/) that will effect the integration with AgentStack.
+Development of AgentStack is being done primarily on [CrewAI](https://crewai.com). We will soon be working to make AgentStack fully framework-agnostic, meaning that any supported multi-agent framework can be used for your project. 
 
 ### Tools
 - Core Tools built by AgentStack
@@ -121,8 +120,6 @@ Some work has been done to add Microsoft's [AutoGen](https://microsoft.github.io
 - A fast interactive test runner with built-in support for coverage reporting.
 - A live development server that warns about common mistakes.
 - A build script to bundle your project for production.
-- Integration with [AgentOps](https://agentops.ai) for AI agent observability.
-- Hassle-free updates for the above tools with a single dependency.
 
 ## License
 

docs/README.md

@@ -0,0 +1,13 @@
+# Docs
+
+## Building
+To build and view docs from this folder, install the Mintlify CLI:
+```bash
+pip install mintlify
+```
+
+then serve it with
+
+```bash
+mintlify dev
+```

docs/contributing/adding-tools.mdx

@@ -8,11 +8,9 @@ If you're reading this section, you probably have a product that AI agents can u
 Adding tools is easy once you understand the project structure. A few things need to be done for a tool to be considered completely supported:
 
 <Steps>
-  <Step title="Modify the tool list data">
-    Add your tool and relevant information to `agentstack/tools/tools.json`
-  </Step>
   <Step title="Create a config for your tool">
-      - As an example, look at `mem0.json`
+      - Create a new tool config at `agentstack/tools/<your_tool>.json`
+      - As an example, look at our [tool config fixture](https://github.com/AgentOps-AI/AgentStack/blob/main/tests/fixtures/tool_config_max.json)
       - AgentStack uses this to know what code to insert where. Follow the structure to add your tool.
   </Step>
   <Step title="Create your implementation for each framework">
@@ -25,4 +23,16 @@ Adding tools is easy once you understand the project structure. A few things nee
   </Step>
   <Step title="Open a PR to add your tool to the next release">
   </Step>
-</Steps>
+</Steps>
+
+# Tool Config
+- `name` (str) - Name of your tool
+- `category` (str) - Category your tool belongs in
+- `tools` (List[str]) - The exported functions within your tool file
+- `url` (str) - URL to where developers can learn more about your tool
+- `tools_bundled` (bool) - True if the tool file exports a list of tools
+- `cta` (str) - Call To Action printed in the terminal after install
+- `env` (dict) - Key: Environment variable name; Value: default value
+- `packages` (List[str]) - Python packages to be installed to support your tool
+- `post_install` (str) - A script to be run after install of your tool
+- `post_remove` (str) - A script to be run after removal of your tool

docs/installation.mdx

@@ -15,14 +15,15 @@ pip install agentstack
 brew tap agentstack-ai/tap
 brew install agentstack
 ```
+```bash uv
+uv install agentstack
+```
 </CodeGroup>
 
 <Note>
     Conda is not supported at this time. AgentStack uses Poetry in your project which [does not play well with Conda](https://github.com/AgentOps-AI/AgentStack/issues/40).
 </Note>
 
-</CodeGroup>
-
 ## After installing
 
 Run `agentstack --version` to verify that the CLI is installed and accessible.

docs/mint.json

@@ -61,7 +61,15 @@
         "tools/core",
         "tools/community"
       ]
-    },{
+    },
+    {
+      "group": "Templating",
+      "pages": [
+        "templates/templates",
+        "templates/community"
+      ]
+    },
+    {
       "group": "Contributing",
       "pages": [
         "contributing/how-to-contribute",

docs/quickstart.mdx

@@ -8,30 +8,32 @@ icon: 'circle-play'
 
 AgentStack's greatest ability is that of quickly scaffolding agent projects
 
-### Wizard
+To start, ensure you have AgentStack [installed](/installation) and run:
+```bash
+agentstack init <project_name>
+```
 
-AgentStack v0.1 supports a friendly setup wizard!
 
-To start, ensure you have AgentStack [installed](/installation) and run:
+**With the Wizard**
+
+Optionally, if you're a little overwhelmed with the code generated, you can use our Wizard to help guide you through some core setup!
 ```bash
-agentstack init
+agentstack init <project_name> --wizard
 ```
 
-<Note>Using the wizard is recommended in AgentStack version 0.1 (current release)</Note>
+**With a Template**
 
+By default, your project will contain no agents or tasks.
 
-### Without Wizard
+If you find it easier to start with a complete project and edit it to fit your use-case, you can use [Templates](/templates/templates)
 
-Starting a project without the wizard is useful if you are past the ideation stage and want to just start with a default project template:
 ```bash
-agentstack init --no-wizard
+agentstack init --template=<template_name/url>
 ```
 
 ## Building your project
 
-By default, your project will contain no agents or tasks.
-
-AgentStack 0.1 is built on top of [CrewAI](https://docs.crewai.com/introduction). The majority of your development experience will be with Crew.
+AgentStack 0.2 is built on top of [CrewAI](https://docs.crewai.com/introduction). The majority of your development experience will be with Crew.
 
 When working with your Crew project, AgentStack makes generating new agents and tasks easy.
 

docs/templates/community.mdx

@@ -0,0 +1,12 @@
+---
+title: 'Community Templates'
+description: 'Extending templating outside what's in the repo'
+---
+
+The easiest way to create your own templates right now is to host them online.
+
+```bash
+agentstack init --template=<your_url>
+```
+
+Much more community template support coming soon!

docs/templates/content_creator.mdx

@@ -0,0 +1,6 @@
+---
+title: 'Content Creator'
+description: 'Research a topic and create content on it'
+---
+
+[View Template](https://github.com/AgentOps-AI/AgentStack/blob/main/agentstack/templates/proj_templates/content_creator.json)

docs/templates/researcher.mdx

@@ -0,0 +1,18 @@
+---
+title: 'Researcher'
+description: 'Research and report result from a query'
+---
+
+[View Template](https://github.com/AgentOps-AI/AgentStack/blob/main/agentstack/templates/proj_templates/research.json)
+
+```bash
+agentstack init --template=research
+```
+
+# Purpose
+
+This agent will accept a query as a string, use Perplexity to research it. Another agent will take the data gathered and perform an analysis focused on answering the query.
+
+# Inputs
+
+`query` (str): the query for the agent to research and report on

docs/templates/system_analyzer.mdx

@@ -0,0 +1,18 @@
+---
+title: 'System Analyzer'
+description: 'Inspect a project directory and improve it'
+---
+
+[View Template](https://github.com/AgentOps-AI/AgentStack/blob/main/agentstack/templates/proj_templates/system_analyzer.json)
+
+```bash
+agentstack init --template=system_analyzer
+```
+
+# Purpose
+
+This agent will accept a query as a string, use Perplexity to research it. Another agent will take the data gathered and perform an analysis focused on answering the query.
+
+# Inputs
+
+`system_path` (str): the absolute path to