Skip to content

Building AI agents, atomically

reorganize docs

KennyVaneetvelde0c3e82b1d617
diff --git a/docs/README.md b/docs/README.md
index eaa54d3..46d3e85 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,27 +1,7 @@
-# Atomic_agents Index
+# Docs
-> Auto-generated documentation index.
+## API docs
+[API docs](./api/README.md)
-A full list of `Atomic_agents` project modules.
-
-- [Atomic Agents](atomic_agents/index.md#atomic-agents)
- - [Agents](atomic_agents/agents/index.md#agents)
- - [BaseChatAgent](atomic_agents/agents/base_chat_agent.md#basechatagent)
- - [ToolInterfaceAgent](atomic_agents/agents/tool_interface_agent.md#toolinterfaceagent)
- - [Lib](atomic_agents/lib/index.md#lib)
- - [Components](atomic_agents/lib/components/index.md#components)
- - [ChatMemory](atomic_agents/lib/components/chat_memory.md#chatmemory)
- - [SystemPromptGenerator](atomic_agents/lib/components/system_prompt_generator.md#systempromptgenerator)
- - [Models](atomic_agents/lib/models/index.md#models)
- - [WebDocument](atomic_agents/lib/models/web_document.md#webdocument)
- - [Tools](atomic_agents/lib/tools/index.md#tools)
- - [Base](atomic_agents/lib/tools/base.md#base)
- - [CalculatorTool](atomic_agents/lib/tools/calculator_tool.md#calculatortool)
- - [Searx](atomic_agents/lib/tools/searx.md#searx)
- - [Web Scraping Tool](atomic_agents/lib/tools/web_scraping_tool.md#web-scraping-tool)
- - [Utils](atomic_agents/lib/utils/index.md#utils)
- - [Format Tool Message](atomic_agents/lib/utils/format_tool_message.md#format-tool-message)
- - [Logger](atomic_agents/lib/utils/logger.md#logger)
- - [Scraping](atomic_agents/lib/utils/scraping/index.md#scraping)
- - [Pdf To Markdown](atomic_agents/lib/utils/scraping/pdf_to_markdown.md#pdf-to-markdown)
- - [Url To Markdown](atomic_agents/lib/utils/scraping/url_to_markdown.md#url-to-markdown)
+## Guides
+[Guides](./guides/)
\ No newline at end of file
diff --git a/docs/api/README.md b/docs/api/README.md
new file mode 100644
index 0000000..eaa54d3
--- /dev/null
+++ b/docs/api/README.md
@@ -0,0 +1,27 @@
+# Atomic_agents Index
+
+> Auto-generated documentation index.
+
+A full list of `Atomic_agents` project modules.
+
+- [Atomic Agents](atomic_agents/index.md#atomic-agents)
+ - [Agents](atomic_agents/agents/index.md#agents)
+ - [BaseChatAgent](atomic_agents/agents/base_chat_agent.md#basechatagent)
+ - [ToolInterfaceAgent](atomic_agents/agents/tool_interface_agent.md#toolinterfaceagent)
+ - [Lib](atomic_agents/lib/index.md#lib)
+ - [Components](atomic_agents/lib/components/index.md#components)
+ - [ChatMemory](atomic_agents/lib/components/chat_memory.md#chatmemory)
+ - [SystemPromptGenerator](atomic_agents/lib/components/system_prompt_generator.md#systempromptgenerator)
+ - [Models](atomic_agents/lib/models/index.md#models)
+ - [WebDocument](atomic_agents/lib/models/web_document.md#webdocument)
+ - [Tools](atomic_agents/lib/tools/index.md#tools)
+ - [Base](atomic_agents/lib/tools/base.md#base)
+ - [CalculatorTool](atomic_agents/lib/tools/calculator_tool.md#calculatortool)
+ - [Searx](atomic_agents/lib/tools/searx.md#searx)
+ - [Web Scraping Tool](atomic_agents/lib/tools/web_scraping_tool.md#web-scraping-tool)
+ - [Utils](atomic_agents/lib/utils/index.md#utils)
+ - [Format Tool Message](atomic_agents/lib/utils/format_tool_message.md#format-tool-message)
+ - [Logger](atomic_agents/lib/utils/logger.md#logger)
+ - [Scraping](atomic_agents/lib/utils/scraping/index.md#scraping)
+ - [Pdf To Markdown](atomic_agents/lib/utils/scraping/pdf_to_markdown.md#pdf-to-markdown)
+ - [Url To Markdown](atomic_agents/lib/utils/scraping/url_to_markdown.md#url-to-markdown)
diff --git a/docs/atomic_agents/agents/base_chat_agent.md b/docs/api/atomic_agents/agents/base_chat_agent.md
similarity index 100%
rename from docs/atomic_agents/agents/base_chat_agent.md
rename to docs/api/atomic_agents/agents/base_chat_agent.md
diff --git a/docs/atomic_agents/agents/index.md b/docs/api/atomic_agents/agents/index.md
similarity index 100%
rename from docs/atomic_agents/agents/index.md
rename to docs/api/atomic_agents/agents/index.md
diff --git a/docs/atomic_agents/agents/tool_interface_agent.md b/docs/api/atomic_agents/agents/tool_interface_agent.md
similarity index 100%
rename from docs/atomic_agents/agents/tool_interface_agent.md
rename to docs/api/atomic_agents/agents/tool_interface_agent.md
diff --git a/docs/atomic_agents/index.md b/docs/api/atomic_agents/index.md
similarity index 100%
rename from docs/atomic_agents/index.md
rename to docs/api/atomic_agents/index.md
diff --git a/docs/atomic_agents/lib/components/chat_memory.md b/docs/api/atomic_agents/lib/components/chat_memory.md
similarity index 100%
rename from docs/atomic_agents/lib/components/chat_memory.md
rename to docs/api/atomic_agents/lib/components/chat_memory.md
diff --git a/docs/atomic_agents/lib/components/index.md b/docs/api/atomic_agents/lib/components/index.md
similarity index 100%
rename from docs/atomic_agents/lib/components/index.md
rename to docs/api/atomic_agents/lib/components/index.md
diff --git a/docs/atomic_agents/lib/components/system_prompt_generator.md b/docs/api/atomic_agents/lib/components/system_prompt_generator.md
similarity index 100%
rename from docs/atomic_agents/lib/components/system_prompt_generator.md
rename to docs/api/atomic_agents/lib/components/system_prompt_generator.md
diff --git a/docs/atomic_agents/lib/index.md b/docs/api/atomic_agents/lib/index.md
similarity index 100%
rename from docs/atomic_agents/lib/index.md
rename to docs/api/atomic_agents/lib/index.md
diff --git a/docs/atomic_agents/lib/models/index.md b/docs/api/atomic_agents/lib/models/index.md
similarity index 100%
rename from docs/atomic_agents/lib/models/index.md
rename to docs/api/atomic_agents/lib/models/index.md
diff --git a/docs/atomic_agents/lib/models/web_document.md b/docs/api/atomic_agents/lib/models/web_document.md
similarity index 100%
rename from docs/atomic_agents/lib/models/web_document.md
rename to docs/api/atomic_agents/lib/models/web_document.md
diff --git a/docs/atomic_agents/lib/tools/base.md b/docs/api/atomic_agents/lib/tools/base.md
similarity index 100%
rename from docs/atomic_agents/lib/tools/base.md
rename to docs/api/atomic_agents/lib/tools/base.md
diff --git a/docs/atomic_agents/lib/tools/calculator_tool.md b/docs/api/atomic_agents/lib/tools/calculator_tool.md
similarity index 100%
rename from docs/atomic_agents/lib/tools/calculator_tool.md
rename to docs/api/atomic_agents/lib/tools/calculator_tool.md
diff --git a/docs/atomic_agents/lib/tools/index.md b/docs/api/atomic_agents/lib/tools/index.md
similarity index 100%
rename from docs/atomic_agents/lib/tools/index.md
rename to docs/api/atomic_agents/lib/tools/index.md
diff --git a/docs/atomic_agents/lib/tools/searx.md b/docs/api/atomic_agents/lib/tools/searx.md
similarity index 100%
rename from docs/atomic_agents/lib/tools/searx.md
rename to docs/api/atomic_agents/lib/tools/searx.md
diff --git a/docs/atomic_agents/lib/tools/web_scraping_tool.md b/docs/api/atomic_agents/lib/tools/web_scraping_tool.md
similarity index 100%
rename from docs/atomic_agents/lib/tools/web_scraping_tool.md
rename to docs/api/atomic_agents/lib/tools/web_scraping_tool.md
diff --git a/docs/atomic_agents/lib/utils/format_tool_message.md b/docs/api/atomic_agents/lib/utils/format_tool_message.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/format_tool_message.md
rename to docs/api/atomic_agents/lib/utils/format_tool_message.md
diff --git a/docs/atomic_agents/lib/utils/index.md b/docs/api/atomic_agents/lib/utils/index.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/index.md
rename to docs/api/atomic_agents/lib/utils/index.md
diff --git a/docs/atomic_agents/lib/utils/logger.md b/docs/api/atomic_agents/lib/utils/logger.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/logger.md
rename to docs/api/atomic_agents/lib/utils/logger.md
diff --git a/docs/atomic_agents/lib/utils/scraping/index.md b/docs/api/atomic_agents/lib/utils/scraping/index.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/scraping/index.md
rename to docs/api/atomic_agents/lib/utils/scraping/index.md
diff --git a/docs/atomic_agents/lib/utils/scraping/pdf_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/scraping/pdf_to_markdown.md
rename to docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md
diff --git a/docs/atomic_agents/lib/utils/scraping/url_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md
similarity index 100%
rename from docs/atomic_agents/lib/utils/scraping/url_to_markdown.md
rename to docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md