FAQs FIX!

- Faqs were replaced by quickstart 🤔
- Fixed all broken links

README.md

@@ -91,7 +91,7 @@ A detailed setup guide for Windows, macOS and Linux with a video can be found in
 The documentation dives deep into the framework and its features. It is a good place to start if you are new to Agent Zero. Click [here](docs/README.md) to see the Documentation.
 
 ## Coming up
-- **Preinstalled bundles**
+- **Preinstalled binaries and bundler scripts**
 - **Knowledge tool open-sourcing and web scraping tool**
 - **User interaction refinements**
 - **In-context switchable LLMs**
@@ -99,17 +99,17 @@ The documentation dives deep into the framework and its features. It is a good p
 ### Changelog [since version 0.7]
 
 #### v0.7.1
-- **Bug Fixes**
 - **Persistent Chats** - Serialized to /tmp/chats and automatically loaded in run_ui.py on startup
-- **Preinstalled binaries and bundler scripts**
 - **Documentation stack merged into the repository**
+- **Bug Fixes**
 
-#### New in version 0.7
-> - UI Revamp
-> - Auto Memory
-> - Instruments
-> - Extensions Framework
-> - Reflection
+#### v0.7
+- **Automatic memory**
+- **UI improvements**
+- **Instruments**
+- **Extensions framework**
+- **Reflection prompts**
+- **Bugfixes**
 
 > [!NOTE]  
 > **Changes to launch files since v0.6:**  

docs/README.md

@@ -2,20 +2,20 @@
 # Agent Zero Documentation
 To begin with Agent Zero, follow the links below for detailed guides on various topics:
 
-- **[Installation](installation.md):** Set up (or [update](installation.md#-how-to-update-agent-zero)) Agent Zero on your system.
+- **[Installation](installation.md):** Set up (or [update](installation.md#how-to-update-agent-zero)) Agent Zero on your system.
 - **[Quick Start](quickstart.md):** Begin using Agent Zero with practical examples.
 - **[Usage Guide](usage.md):** Explore advanced features and capabilities.
 - **[Architecture Overview](architecture.md):** Understand the internal workings of the framework.
 - **[Contributing](contribution.md):** Learn how to contribute to the Agent Zero project.
 - **[Troubleshooting and FAQ](troubleshooting.md):** Find answers to common issues and questions.
-
+##
 ### Your experience with Agent Zero starts now!
 
 - **Download Agent Zero:** Download the latest release from the [GitHub releases page](https://github.com/frdel/agent-zero/releases).
 - **Join the Community:** Join the Agent Zero [Skool](https://www.skool.com/agent-zero) or [Discord](https://discord.gg/Z2tun2N3) community to discuss ideas, ask questions, and collaborate with other contributors.
 - **Share your Work:** Share your Agent Zero creations, workflows and discoverings on our [Show and Tell](https://github.com/frdel/agent-zero/discussions/categories/show-and-tell) area on GitHub.
-- **Report Issues:** Use the GitHub issue tracker to report bugs or suggest new features.
-
+- **Report Issues:** Use the [GitHub issue tracker](https://github.com/frdel/agent-zero/issues) to report framework-relative bugs or suggest new features.
+##
 ## Table of Contents
 
 - [Welcome to the Agent Zero Documentation](#agent-zero-documentation)
@@ -34,8 +34,8 @@ To begin with Agent Zero, follow the links below for detailed guides on various
     - [5. Configure Agent Zero](installation.md#5-configure-agent-zero)
     - [6. Run Agent Zero](installation.md#6-run-agent-zero)
     - [Choosing Your LLMs](installation.md#choosing-your-llms)
-      - [Installing and Using Ollama](installation.md#installing-and-using-ollama)
-    - [How to update Agent Zero](installation.md#-how-to-update-agent-zero)
+      - [Installing and Using Ollama](installation.md#installing-and-using-ollama-local-models)
+    - [How to update Agent Zero](installation.md#how-to-update-agent-zero)
     - [How to create executable files for Agent Zero](installation.md#how-to-create-executable-files-for-agent-zero-in-windows-macos-and-linux)
     - [Conclusion](installation.md#conclusion)
 - [Quick Start](quickstart.md)
@@ -68,42 +68,15 @@ To begin with Agent Zero, follow the links below for detailed guides on various
   - [Customization](architecture.md#customization)
     - [Custom Prompts](architecture.md#custom-prompts)
       - [Changing the System Prompt Folder](architecture.md#changing-the-system-prompt-folder)
-      - [Editing Prompts](architecture.md#editing-prompts)
     - [AgentConfig](architecture.md#agentconfig)
     - [Adding Tools](architecture.md#adding-tools)
     - [Adding Instruments](architecture.md#adding-instruments)
     - [Adding Extensions](architecture.md#adding-extensions)
-    - [Important Considerations](architecture.md#important-considerations)
 - [Contributing to Agent Zero](contribution.md)
   - [Getting Started](contribution.md#getting-started)
   - [Making Changes](contribution.md#making-changes)
   - [Submitting a Pull Request](contribution.md#submitting-a-pull-request)
   - [Documentation Stack](contribution.md#documentation-stack)
-- [Troubleshooting and FAQ](troubleshooting.md)
+- [FAQ and Troubleshooting](troubleshooting.md)
   - [Frequently Asked Questions](troubleshooting.md#frequently-asked-questions)
-  - [Troubleshooting](troubleshooting.md#troubleshooting)
-    - [Installation](troubleshooting.md#installation)
-    - [Usage](troubleshooting.md#usage)
-
-## Changelog [since version 0.7]
-
-### v0.7.1
-- **Bug Fixes**
-- **Persistent Chats** - Serialized to /tmp/chats and automatically loaded in run_ui.py on startup
-- **Preinstalled binaries and bundler scripts**
-- **Documentation stack merged into the repository**
-
-### v0.7
-- **Auto Memory System**
-- **UI Revamp**
-    - The chat interface is now fully responsive, has a progress bar and supports both light and dark themes.
-- **Instruments**: Users can create custom tools (instruments) using markdown files. These instruments execute commands within the Docker container and can be used to perform various tasks, such as downloading YouTube videos or executing scripts.
-- **Extensions Framework**
-    - A new extensions framework has been introduced to keep the main agent.py file clean and maintainable. This allows for better organization of code with various subfolders for different functionalities. Files within python/extensions folders are executed in alphabetical order, streamlining processes like memory recall and solution memorization.
-- **Reflection**
-    - The framework supports advanced AI concepts like Chain of Thought and reflection through customizable prompts. Users can choose between two reflection models: dianoia-small and dianoia-xl.
-
-> [!WARNING]  
-> Changes to launch files since v0.6:
-> - main.py file has been replaced with run_ui.py (Web UI) and run_cli.py (terminal) launch files.
-> - The configuration has been moved to initialize.py for both Web UI and CLI launch files.
+  - [Troubleshooting](troubleshooting.md#troubleshooting)

docs/installation.md

@@ -4,7 +4,7 @@
 
 The following guide provides both quick start instructions for the full installation of Agent Zero on various operating systems and in-depth guides for Windows and macOS with screenshots.
 
-## You were looking for this? [How to update Agent Zero](#-how-to-update-agent-zero)
+## You were looking for this? [How to update Agent Zero](#how-to-update-agent-zero)
 
 <details>
 <summary><h2>Windows Quick Start</h2></summary>
@@ -227,7 +227,7 @@ python run_ui.py
 <img src="res/setup/image-23-1.png" alt="run ui" width="400"/>
 <br><br>
 
-## Choosing Your LLMs
+# Choosing Your LLMs
 The `initialize.py` file is the control center for selecting the Large Language Models (LLMs) that power Agent Zero.  You can choose different LLMs for different roles:
 
 | LLM Role | Description |
@@ -254,7 +254,7 @@ The `initialize.py` file is the control center for selecting the Large Language
 
 - Experiment with different model combinations to find the balance of performance and cost that best suits your needs. E.g., faster and lower latency LLMs will help, and you can also use `faiss_gpu` instead of `faiss_cpu` for the memory.
 
-### Installing and Using Ollama (Local Models)
+## Installing and Using Ollama (Local Models)
 If you're interested in Ollama, which is a powerful tool that allows you to run various large language models locally, here's how to install and use it:
 
 #### First step: installation
@@ -300,7 +300,7 @@ Once you've downloaded some models, you might want to check which ones you have
   ollama rm <model-name>
   ```
 
-## How to update Agent Zero
+# How to update Agent Zero
 To update Agent Zero to the latest version, follow these steps:
 - **Using Git/GitHub:** Pull the latest version of the Agent Zero repository with Git/GitHub. The custom knowledge, solutions, memory, and other data will get ignored by Git, so you don't need to worry about losing any of your custom data. The same goes for your .env file with all of your API keys.
 - **Backup LLM choices**: Before updating, make sure to save your customizations you've made to the first part of `def_initialize` function in the `initialize.py` file to choose your LLMs (highlighted section in below figure). This is important because the update process will overwrite these files with the default versions from the repository and can save you time rewriting all your LLMs choices.
@@ -330,5 +330,5 @@ Two scripts allows you to easily create executable files for Windows, macOS and
 > are run. If you want to run Agent Zero on another machine, you will need to run 
 > the scripts on that machine as well to have executable files.
       
-## Conclusion
+### Conclusion
 After following the instructions for your specific operating system, you should have Agent Zero successfully installed and running. You can now start exploring the framework's capabilities and experimenting with creating your own intelligent agents.  If you encounter any issues during the installation process, please consult the Troubleshooting section of this documentation or refer to the Agent Zero community for assistance.

docs/quickstart.md

@@ -18,8 +18,11 @@ python run_ui.py
 
 ![New Chat](res/ui_newchat1.png)
 
-- As you can see, the Web UI has four distinct buttons for easy chat management: `New Chat`, `Reset Chat`, `Save Chat`, and `Load Chat`.
-- Chats can be saved and loaded individually in `json` format and are stored in the `/tmp/chats` directory.
+> [!TIP]
+> As you can see, the Web UI has four distinct buttons for easy chat management: 
+> `New Chat`, `Reset Chat`, `Save Chat`, and `Load Chat`.
+> Chats can be saved and loaded individually in `json` format and are stored in the
+> `/tmp/chats` directory.
 
     ![Chat Management](res/ui_chat_management.png)
 
@@ -45,4 +48,7 @@ Now that you've run a simple task, you can experiment with more complex requests
 * Explore web development tasks
 * Create or modify files
 
-The Usage Guide provides more in-depth information on using Agent Zero's various features, including prompt engineering, tool usage, and multi-agent cooperation.
+> [!TIP]
+> The [Usage Guide](usage.md) provides more in-depth information on using Agent 
+> Zero's various features, including prompt engineering, tool usage, and multi-agent 
+> cooperation.

docs/troubleshooting.md

@@ -1,51 +1,56 @@
-# Quick Start
-This guide provides a quick introduction to using Agent Zero. We'll cover launching the web UI, starting a new chat, and running a simple task.
-
-## Launching the Web UI
-1. Make sure you have Agent Zero installed and your environment set up correctly (refer to the [Installation guide](installation.md) if needed).
-2. Open a terminal in the Agent Zero directory and activate your conda environment (if you're using one).
-3. Run the following command:
+# Troubleshooting and FAQ
+This page addresses frequently asked questions (FAQ) and provides troubleshooting steps for common issues encountered while using Agent Zero.
+
+## Frequently Asked Questions
+**1. How do I set up and activate a Python virtual environment?**
+Use the `venv` module or `conda` (recommended).
+* **`venv`:**
+    ```bash
+    python -m venv .venv  # Create the environment
+    source .venv/bin/activate  # Activate (Linux/macOS)
+    .venv\Scripts\activate  # Activate (Windows)
+    ```
+* **`conda`:**
+    ```bash
+    conda create -n agent-zero python=3.12  # Create
+    conda activate agent-zero  # Activate
+    ```
+**2. How do I resolve `ModuleNotFoundError` errors (e.g., for `ansio`, `pyflakes`, `Flask`)?**
+Ensure your virtual environment is activated *before* installing requirements:
 
 ```bash
-python run_ui.py
+pip install -r requirements.txt
 ```
 
-4.  A message similar to this will appear in your terminal, indicating the Web UI is running:
-
-![](res/flask_link.png)
-
-5. Open your web browser and navigate to the URL shown in the terminal (usually `http://127.0.0.1:50001`). You should see the Agent Zero Web UI.
+**3. How do I integrate open-source models with Agent Zero?**
+Refer to the [Choosing your LLMs](installation.md#installing-and-using-ollama-local-models) section of the documentation for detailed instructions and examples for configuring different LLMs in `initialize.py`. Local models can be run using Ollama or LM Studio.
 
-![New Chat](res/ui_newchat1.png)
+> [!TIP]  
+> Some LLM providers offer free usage of their APIs, for example Groq, Mistral or SambaNova.
 
-> [!TIP]
-> As you can see, the Web UI has four distinct buttons for easy chat management: 
-> `New Chat`, `Reset Chat`, `Save Chat`, and `Load Chat`.
-> Chats can be saved and loaded individually in `json` format and are stored in the
-> `/tmp/chats` directory.
+**4. How can I make Agent Zero retain memory between sessions?**
+Auto memory automatically saves and loads solutions and informations from previous sessions.
 
-    ![Chat Management](res/ui_chat_management.png)
+**5. Where can I find more documentation or tutorials?**
+*   Join the Agent Zero [Skool](https://www.skool.com/agent-zero) or [Discord](https://discord.gg/Z2tun2N3) community for support and discussions.
 
-## Running a Simple Task
-Let's ask Agent Zero to download a YouTube video. Here's how:
+**6. How do I adjust API rate limits?**
+Modify the `rate_limit_seconds` and `rate_limit_requests` parameters in the `AgentConfig` class within `initialize.py`.
 
-1.  Type "Download a YouTube video for me" in the chat input field and press Enter or click the send button.
+**7. Can Agent Zero interact with external APIs or services (e.g., WhatsApp)?**
+Extending Agent Zero to interact with external APIs is possible by creating custom tools or solutions. Refer to the documentation on creating them. 
 
-2. Agent Zero will process your request.  You'll see its "thoughts" and the actions it takes displayed in the UI. It will find a default already existing solution, that implies using the `code_execution_tool` to run a simple Python script to perform the task.
+## Troubleshooting
 
-3. The agent will then ask you for the URL of the YouTube video you want to download.
+**Installation**
+* **Dependency Conflicts:** If encountering version conflicts during installation, try creating a fresh virtual environment and reinstalling the requirements.
+* **Docker Issues:** If Docker containers fail to start or Agent Zero can't connect to Docker, consult the Docker documentation and verify your Docker installation and configuration.  On macOS, ensure you've granted Docker access to your project files in Docker Desktop's settings as described in the [Installation guide](installation.md#2-install-docker-docker-desktop-application).
 
-## Example Interaction
-Here's an example of what you might see in the Web UI at step 3:
-![1](res/image-24.png)
+**Usage**
+* **"Nothing happens" when sending a message:** This often indicates a tool execution issue, an API connection problem, or rate limiting. Check your API keys, internet connection, and ensure any required services (like Docker) are running.  Examine the logs for more details.
 
-## Next Steps
-Now that you've run a simple task, you can experiment with more complex requests. Try asking Agent Zero to:
+* **Terminal commands not executing:** If using Docker for code execution, ensure the Docker container is running and properly configured.  Check SSH settings if applicable.
 
-* Perform calculations
-* Search the web for information
-* Execute shell commands
-* Explore web development tasks
-* Create or modify files
+* **Error Messages:** Pay close attention to the error messages displayed in the Web UI or terminal.  They often provide valuable clues for diagnosing the issue. Refer to the specific error message in online searches or community forums for potential solutions.
 
-The [Usage Guide](usage.md) provides more in-depth information on using Agent Zero's various features, including prompt engineering, tool usage, and multi-agent cooperation.
+* **Performance Issues:** If Agent Zero is slow or unresponsive, it might be due to resource limitations, network latency, or the complexity of your prompts and tasks.