diff --git a/docs/content/platform/create-basic-agent.md b/docs/content/platform/create-basic-agent.md new file mode 100644 index 000000000..7721fb9b9 --- /dev/null +++ b/docs/content/platform/create-basic-agent.md @@ -0,0 +1,112 @@ +# **Creating a Basic AI Agent with AutoGPT** + +## **Overview** + +This guide walks through creating a simple question-answer AI agent using AutoGPT's visual builder. This is a basic example that can be expanded into more complex agents. + +## **Example Agent: Q&A (with AI)** + +A step-by-step guide to creating a simple Q&A agent using input and output blocks. + +
+ +## **Components Required** +1. Input Block +2. AI Text Generator Block +3. Output Block + +## **Step-by-Step Instructions** + +### **1. Set Up the Basic Structure** +1. Add an Input Block +2. Add an AI Text Generator Block +3. Add an Output Block + +### **2. Connect the Components** +1. Connect the Input Block to the AI Text Generator's Prompt +2. Connect the AI Text Generator's response to the Output Block's value + +### **3. Configure Block Names** +* Name the Input Block: "question" +* Name the Output Block: "answer" + +### **4. Save the Agent** +1. Click the Save button +2. Name your agent (e.g., "question and answer") + +### **5. Test the Agent** +1. Click the Run button +2. Enter a question in the input field (e.g., "How far is Earth from Pluto?") +3. View the results through either: + * The "View More" option + * The "Agent Outputs" section + +## **Viewing Results** + +You can access the AI's response in two ways: + +* Click "View More" for detailed results +* Check the "Agent Outputs" section for the response + +## **Example Agent: Calculator (without AI)** + +A step-by-step guide to creating a simple calculator agent using input and output blocks. + +
+ +##**Components Required** +* Input Block (2 instances) +* Calculator Block +* Output Block + +## **Setup Instructions** + +### **1. Adding Input Blocks** +1. Add two input blocks, positioned one below the other +2. Name the first input block "a" +3. Name the second input block "b" + +### **2. Adding Calculator Block** +1. Add a calculator block to your workspace +2. Position it after the input blocks + +### **3. Adding Output Block** +1. Add an output block +2. Name it "results" + +### **4. Connecting the Blocks** +1. Connect the "a" input block to the "a" input on the calculator block +2. Connect the "b" input block to the "b" input on the calculator block +3. Connect the calculator block's result to the value input of the output block + +### **5. Saving Your Agent** +1. Name your agent (e.g., "Simple Calculate Agent") +2. Save the configuration + +## **Testing Your Calculator** + +### **Running Calculations** +1. Enter values in both input blocks +2. Select the desired operation (e.g., multiply) +3. Click the "Run" button to execute the calculation + +### **Viewing Results** + +There are two ways to view the calculation results: + +1. Click "View More" to see the detailed output +2. Check the "Agent Outputs" section, which displays results from the output block + +## **Example Calculation** +* Input A: 227 +* Input B: 17 +* Operation: Multiply +* Expected output will be shown in the results section + +## **Tips** +* Always save your agent after making changes +* Verify all connections are properly made before running +* Use the "View More" option for detailed output information + +## **Note** +While these are basic example, you can enhance the agent with additional blocks and functionality to create more complex interactions. \ No newline at end of file diff --git a/docs/content/platform/delete-agent.md b/docs/content/platform/delete-agent.md new file mode 100644 index 000000000..517cb35ee --- /dev/null +++ b/docs/content/platform/delete-agent.md @@ -0,0 +1,23 @@ +# **How to Delete an Agent in AutoGPT** + +## **Overview** + +Is your AutoGPT Monitor getting cluttered or did you create an agent you no longer see? Learn how to quickly delete unwanted agents. + +
+ +## **Steps to Delete an Agent** +1. **Locate the Agent** + * Navigate to the Monitor Tab in the AutoGPT builder + * Find the agent you want to delete from the list +2. **Select the Agent** + * Click on the agent you wish to delete +3. **Delete the Agent** + * Look for the trash icon on the right side of the interface + * Click the trash icon + * A confirmation dialog will appear asking "Are you sure you want to delete this agent?" + * Click "Yes, delete" to confirm + +Once confirmed, the agent will be immediately removed from your list. + +**Note**: This action cannot be undone, so make sure you want to permanently delete the agent before confirming. \ No newline at end of file diff --git a/docs/content/platform/download-agent-from-marketplace-local.md b/docs/content/platform/download-agent-from-marketplace-local.md new file mode 100644 index 000000000..22e212262 --- /dev/null +++ b/docs/content/platform/download-agent-from-marketplace-local.md @@ -0,0 +1,41 @@ +# **How to Download and Import an Agent from the AutoGPT Marketplace (Local Hosting)** + +## **Overview** +This guide explains how to download an agent from the AutoGPT marketplace and import it into your locally hosted instance. + +
+ +## **Prerequisites** +* A local installation of AutoGPT +* Access to the marketplace for local hosters + +## **Step-by-Step Process** + +### **1. Access the Marketplace** +* Navigate to the marketplace section + * Note: The interface will differ from the cloud-hosted platform + +### **2. Download the Agent** +1. Browse and select your desired agent +2. Click on the agent to view details +3. Look for and click the "Download Agent" button +4. The agent file will save to your computer + +### **3. Import the Agent** +1. Return to the Monitor tab +2. Locate the dropdown menu next to "Create" +3. Select "Import from File" +4. In the file selection dialog: + * Navigate to your downloaded agent file + * Select the file + * Click "Open" +5. Click "Import and Edit" + +### **4. Verify Import** +* The agent should now appear in your Builder +* You can begin editing or using the imported agent + +## **Important Notes** +* The marketplace interface differs between local hosting and cloud-hosted versions +* Ensure you're following the local hosting specific steps +* The agent will be available in your Builder after successful import \ No newline at end of file diff --git a/docs/content/platform/edit-agent.md b/docs/content/platform/edit-agent.md new file mode 100644 index 000000000..60015b02a --- /dev/null +++ b/docs/content/platform/edit-agent.md @@ -0,0 +1,35 @@ +# **How to Edit an Agent in AutoGPT** + +## **Overview** + +This guide explains how to access and edit existing agents in AutoGPT, whether they're your own creations or downloaded from the marketplace. + +
+ +## **Steps to Edit an Agent** + +### **1. Access the Monitor Tab** +* Navigate to the Monitor Tab in the AutoGPT builder +* You'll see a list of all your agents, including: + * Agents you've created + * Agents downloaded from the marketplace + +### **2. Select the Agent** +* Locate the agent you want to edit from the list +* Click on the agent name to select it + +### **3. Enter Edit Mode** +* Look for the pencil icon next to the selected agent +* Click the pencil icon to open the editor + + +### **4. Modify the Agent** +* The agent will load in the editor with all its existing components +* Make your desired modifications to the agent's configuration + +### **5. Save Changes** +* After making your modifications, save the updated agent + +## **Note** +* All agents can be edited, regardless of whether they were created by you or downloaded from the marketplace +* Changes are saved to your local instance \ No newline at end of file diff --git a/docs/content/platform/submit-agent-to-marketplace.md b/docs/content/platform/submit-agent-to-marketplace.md new file mode 100644 index 000000000..b67f1cc4d --- /dev/null +++ b/docs/content/platform/submit-agent-to-marketplace.md @@ -0,0 +1,35 @@ +# **How to Submit an Agent to the AutoGPT Marketplace** + +
+ +## **Prerequisites** +* A completed agent built using the AutoGPT Builder +* Your agent must be saved before submission + +## **Submission Steps** +1. **Access the Submission Form** + * Navigate to the marketplace + * Click the "Submit Agent" button +2. **Select Your Agent** + * Use the dropdown menu to select your completed agent +3. **Fill Out Required Information** + * Add a detailed description of your agent + * Enter the author name + * Add at least one keyword to help users find your agent + * Select the most relevant category for your agent +4. **Review Terms** + * Read and agree to the marketplace terms +5. **Submit for Review** + * Click the "Submit" button to complete your submission + +## **After Submission** +* Your agent will enter a "pending" state +* The AutoGPT team will review your submission +* If approved, your agent will appear in the marketplace as a new listing + + +## **Tips for a Successful Submission** +* Provide a clear, detailed description of what your agent does +* Choose relevant keywords that accurately describe your agent's functionality +* Ensure your agent is fully tested and working as intended before submission +* Select the most appropriate category to help users find your agent \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 66653a0e1..0f4658322 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -8,7 +8,13 @@ nav: - Home: index.md - The AutoGPT Platform 🆕: - - Getting Started: platform/getting-started.md + - Getting Started: + - Setup AutoGPT (Local-Host): platform/getting-started.md + - Edit an Agent: platform/edit-agent.md + - Delete an Agent: platform/delete-agent.md + - Download & Import and Agent: platform/download-agent-from-marketplace-local.md + - Create a Basic Agent: platform/create-basic-agent.md + - Submit an Agent to the Marketplace: platform/submit-agent-to-marketplace.md - Advanced Setup: platform/advanced_setup.md - Agent Blocks: platform/agent-blocks.md - Build your own Blocks: platform/new_blocks.md @@ -156,7 +162,6 @@ plugins: - git-revision-date-localized: enable_creation_date: true - extra: social: - icon: fontawesome/brands/github