Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Docs: Remove Bugs and improve indentation (#2694)

Sarthak Bhardwaj0210a10d9591
diff --git a/docs/mintlify/cookbooks/data_processing/summarisation_agent_with_mistral_ocr.mdx b/docs/mintlify/cookbooks/data_processing/summarisation_agent_with_mistral_ocr.mdx
index 30d49578b..c39379bd5 100644
--- a/docs/mintlify/cookbooks/data_processing/summarisation_agent_with_mistral_ocr.mdx
+++ b/docs/mintlify/cookbooks/data_processing/summarisation_agent_with_mistral_ocr.mdx
@@ -25,7 +25,6 @@ In this cookbook, we’ll explore [**Mistral OCR**](https://mistral.ai/news/mist
<img src="https://i.postimg.cc/L4wPdG9N/join-2.png" width="150" alt="Join Discord"/>
</a>
</div>
-
⭐ *Star us on [GitHub](https://github.com/camel-ai/camel), join our [Discord](https://discord.camel-ai.org), or follow us on [X](https://x.com/camelaiorg)*
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 2f49a6771..7abfcc116 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -55,21 +55,21 @@
"group": "Key Modules",
"pages": [
"key_modules/agents",
+ "key_modules/models",
+ "key_modules/tools",
+ "key_modules/societies",
+ "key_modules/workforce",
"key_modules/datagen",
"key_modules/interpreters",
"key_modules/runtimes",
- "key_modules/society",
- "key_modules/models",
"key_modules/messages",
"key_modules/memory",
- "key_modules/tools",
"key_modules/prompts",
"key_modules/tasks",
"key_modules/loaders",
"key_modules/storages",
"key_modules/embeddings",
- "key_modules/retrievers",
- "key_modules/workforce"
+ "key_modules/retrievers"
]
},
{
diff --git a/docs/mintlify/key_modules/memory.mdx b/docs/mintlify/key_modules/memory.mdx
index fd06347a0..7a7dd7838 100644
--- a/docs/mintlify/key_modules/memory.mdx
+++ b/docs/mintlify/key_modules/memory.mdx
@@ -94,8 +94,6 @@ print(file_obj.docs[0]["page_content"])
</CodeGroup>
</Card>
----
-
<Card title="Using Unstructured IO" icon="puzzle">
To get started with the <code>Unstructured IO</code> module, just import and initialize it. You can parse, clean, extract, chunk, and stage data from files or URLs. Here’s how you use it step by step:
@@ -137,8 +135,6 @@ print(("\n\n".join([str(el) for el in elements])))
extra spaces and dashes. ```
</CodeGroup>
-<br />
-
<strong>3. Extract data from text (for example, emails):</strong>
<CodeGroup>
```python unstructured_io_extract.py
@@ -228,8 +224,6 @@ print(dataset_result)
</CodeGroup>
</Card>
----
-
<Card title="Using Firecrawl Reader" icon="fire">
Firecrawl Reader provides a simple way to turn any website into LLM-ready markdown format. Here’s how you can use it step by step:
@@ -286,8 +280,6 @@ Firecrawl Reader provides a simple way to turn any website into LLM-ready markdo
That’s it. With just a couple of lines, you can turn any website into clean markdown, ready for LLM pipelines or further processing.
</Card>
----
-
<Card title="Using Chunkr Reader" icon="cuttlefish">
Chunkr Reader allows you to process PDFs (and other docs) in chunks, with built-in OCR and format control.
Below is a basic usage pattern:
@@ -362,8 +354,6 @@ print(response)
</Card>
----
-
<Card title="Using MarkitDown Reader" icon="notebook">
MarkitDown Reader lets you convert files (like HTML or docs) into LLM-ready markdown with a single line.
diff --git a/docs/mintlify/key_modules/runtimes.mdx b/docs/mintlify/key_modules/runtimes.mdx
index 687fae617..718002b36 100644
--- a/docs/mintlify/key_modules/runtimes.mdx
+++ b/docs/mintlify/key_modules/runtimes.mdx
@@ -52,9 +52,6 @@ CAMEL’s **runtime module** enables the secure, flexible, and isolated executio
</div>
-
----
-
## Runtime Interface
All runtimes inherit from <b>BaseRuntime</b>, which defines core methods:
@@ -62,8 +59,6 @@ All runtimes inherit from <b>BaseRuntime</b>, which defines core methods:
- <code>reset()</code>: Reset the runtime to its initial state
- <code>get_tools()</code>: List all tools managed by the runtime
----
-
## Quick Start Example: RemoteHttpRuntime
<Card icon="zap" title="Remote HTTP Runtime Example" className="my-6">
@@ -93,8 +88,6 @@ All runtimes inherit from <b>BaseRuntime</b>, which defines core methods:
```
</Card>
----
-
## Runtime Types: Key Features
<AccordionGroup>
@@ -127,15 +120,11 @@ All runtimes inherit from <b>BaseRuntime</b>, which defines core methods:
</Accordion>
</AccordionGroup>
----
-
## More Examples
You’ll find runnable scripts for each runtime in <b>[examples/runtime](https://github.com/camel-ai/camel/tree/master/examples/runtimes)/</b> in our main repo.
Each script demonstrates how to initialize and use a specific runtime—perfect for experimentation or production setups.
----
-
## Final Note
The runtime system primarily sandboxes <code>FunctionTool</code>-style tool functions.
diff --git a/docs/mintlify/key_modules/society.mdx b/docs/mintlify/key_modules/societies.mdx
similarity index 85%
rename from docs/mintlify/key_modules/society.mdx
rename to docs/mintlify/key_modules/societies.mdx
index ea01bab8f..8aa79b35b 100644
--- a/docs/mintlify/key_modules/society.mdx
+++ b/docs/mintlify/key_modules/societies.mdx
@@ -1,5 +1,5 @@
---
-title: "Society"
+title: "Societies"
description: "Collaborative agent frameworks in CAMEL: autonomous social behaviors, role-based task solving, and turn-based agent societies."
icon: people-group
---
@@ -9,24 +9,13 @@ icon: people-group
It powers <b>autonomous, multi-role agents</b> that can plan, debate, critique, and solve tasks together, minimizing human intervention while maximizing alignment with your goals.
</Note>
----
-
<Card icon="users" title="Society Concepts: How Do AI Agents Interact?" className="my-6">
<b>Task:</b> An objective or idea, given as a simple prompt.<br/>
<b>AI User:</b> The role responsible for providing instructions or challenges.<br/>
<b>AI Assistant:</b> The role tasked with generating solutions, plans, or step-by-step responses.<br/>
<b>Critic (optional):</b> An agent that reviews or critiques the assistant's responses for quality control.<br/><br/>
- <b>Frameworks:</b>
- <ul>
- <li><code>RolePlaying</code> — Advanced turn-taking, prompt-guarded collaboration (most common for LLM societies).</li>
- <li><code>BabyAGI</code> — Autonomous, open-ended R&D loops for big-picture or research goals.</li>
- </ul>
</Card>
----
-
-## šŸ¤ Frameworks
-
<div style={{ display: "flex", gap: "1.5rem", flexWrap: "wrap" }}>
<Card icon="repeat" title="RolePlaying" style={{ flex: "1 1 320px" }}>
<b>Turn-based, prompt-engineered, zero-role-flip agent collaboration.</b>
@@ -47,19 +36,8 @@ icon: people-group
</ul>
</div>
</Card>
- <Card icon="flask" title="BabyAGI" style={{ flex: "1 1 320px" }}>
- <b>Task-driven, fully autonomous project agent</b><br/>
- Based on <a href="https://github.com/yoheinakajima/babyagi" target="_blank">BabyAGI</a>, with seamless CAMEL integration.
- <ul>
- <li>Self-driven research, R&D, and iterative problem-solving</li>
- <li>Builds, updates, and executes dynamic task lists</li>
- <li>Minimal initial human input—agents break down and solve tasks</li>
- </ul>
- </Card>
</div>
----
-
## 🧩 RolePlaying Attributes
<AccordionGroup>
@@ -97,8 +75,6 @@ icon: people-group
</Accordion>
</AccordionGroup>
----
-
<Card icon="zap" title="Get Started: RolePlaying in Action" className="my-6">
<b>Example: Turn-based multi-agent chat with custom roles and live output colors.</b>
<br/><br/>
@@ -182,20 +158,6 @@ if __name__ == "__main__":
~~~
</Card>
----
-
-<Card icon="flask-conical" title="Framework Spotlight: BabyAGI" className="my-6">
- <b>Autonomous project agent—no human in the loop.</b><br/>
- <a href="https://github.com/yoheinakajima/babyagi" target="_blank">Original BabyAGI repo</a>
- <ul>
- <li>Designed for long-horizon, open-ended R&D</li>
- <li>Automatically breaks down, plans, and solves complex tasks</li>
- <li>Integrates with CAMEL's toolkit system for supercharged capabilities</li>
- </ul>
-</Card>
-
----
-a\
<AccordionGroup>
<Accordion title="Tips & Best Practices">
<ul>
diff --git a/docs/mintlify/key_modules/tools.mdx b/docs/mintlify/key_modules/tools.mdx
index 752051737..fe0b84a5b 100644
--- a/docs/mintlify/key_modules/tools.mdx
+++ b/docs/mintlify/key_modules/tools.mdx
@@ -15,8 +15,6 @@ For more detailed usage information, please refer to our cookbook: [Tools Cookbo
CAMEL provides a range of built-in toolkits—covering everything from web search and data extraction to code execution, GitHub integration, and much more.
</Card>
----
-
## Get Started
<Card title="Install Toolkits" icon="terminal">