Building AI agents, atomically
reorganize docs
KennyVaneetvelde0c3e82b1d617
diff --git a/docs/README.md b/docs/README.mdindex 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 filediff --git a/docs/api/README.md b/docs/api/README.mdnew file mode 100644index 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.mdsimilarity index 100%rename from docs/atomic_agents/agents/base_chat_agent.mdrename to docs/api/atomic_agents/agents/base_chat_agent.mddiff --git a/docs/atomic_agents/agents/index.md b/docs/api/atomic_agents/agents/index.mdsimilarity index 100%rename from docs/atomic_agents/agents/index.mdrename to docs/api/atomic_agents/agents/index.mddiff --git a/docs/atomic_agents/agents/tool_interface_agent.md b/docs/api/atomic_agents/agents/tool_interface_agent.mdsimilarity index 100%rename from docs/atomic_agents/agents/tool_interface_agent.mdrename to docs/api/atomic_agents/agents/tool_interface_agent.mddiff --git a/docs/atomic_agents/index.md b/docs/api/atomic_agents/index.mdsimilarity index 100%rename from docs/atomic_agents/index.mdrename to docs/api/atomic_agents/index.mddiff --git a/docs/atomic_agents/lib/components/chat_memory.md b/docs/api/atomic_agents/lib/components/chat_memory.mdsimilarity index 100%rename from docs/atomic_agents/lib/components/chat_memory.mdrename to docs/api/atomic_agents/lib/components/chat_memory.mddiff --git a/docs/atomic_agents/lib/components/index.md b/docs/api/atomic_agents/lib/components/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/components/index.mdrename to docs/api/atomic_agents/lib/components/index.mddiff --git a/docs/atomic_agents/lib/components/system_prompt_generator.md b/docs/api/atomic_agents/lib/components/system_prompt_generator.mdsimilarity index 100%rename from docs/atomic_agents/lib/components/system_prompt_generator.mdrename to docs/api/atomic_agents/lib/components/system_prompt_generator.mddiff --git a/docs/atomic_agents/lib/index.md b/docs/api/atomic_agents/lib/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/index.mdrename to docs/api/atomic_agents/lib/index.mddiff --git a/docs/atomic_agents/lib/models/index.md b/docs/api/atomic_agents/lib/models/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/models/index.mdrename to docs/api/atomic_agents/lib/models/index.mddiff --git a/docs/atomic_agents/lib/models/web_document.md b/docs/api/atomic_agents/lib/models/web_document.mdsimilarity index 100%rename from docs/atomic_agents/lib/models/web_document.mdrename to docs/api/atomic_agents/lib/models/web_document.mddiff --git a/docs/atomic_agents/lib/tools/base.md b/docs/api/atomic_agents/lib/tools/base.mdsimilarity index 100%rename from docs/atomic_agents/lib/tools/base.mdrename to docs/api/atomic_agents/lib/tools/base.mddiff --git a/docs/atomic_agents/lib/tools/calculator_tool.md b/docs/api/atomic_agents/lib/tools/calculator_tool.mdsimilarity index 100%rename from docs/atomic_agents/lib/tools/calculator_tool.mdrename to docs/api/atomic_agents/lib/tools/calculator_tool.mddiff --git a/docs/atomic_agents/lib/tools/index.md b/docs/api/atomic_agents/lib/tools/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/tools/index.mdrename to docs/api/atomic_agents/lib/tools/index.mddiff --git a/docs/atomic_agents/lib/tools/searx.md b/docs/api/atomic_agents/lib/tools/searx.mdsimilarity index 100%rename from docs/atomic_agents/lib/tools/searx.mdrename to docs/api/atomic_agents/lib/tools/searx.mddiff --git a/docs/atomic_agents/lib/tools/web_scraping_tool.md b/docs/api/atomic_agents/lib/tools/web_scraping_tool.mdsimilarity index 100%rename from docs/atomic_agents/lib/tools/web_scraping_tool.mdrename to docs/api/atomic_agents/lib/tools/web_scraping_tool.mddiff --git a/docs/atomic_agents/lib/utils/format_tool_message.md b/docs/api/atomic_agents/lib/utils/format_tool_message.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/format_tool_message.mdrename to docs/api/atomic_agents/lib/utils/format_tool_message.mddiff --git a/docs/atomic_agents/lib/utils/index.md b/docs/api/atomic_agents/lib/utils/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/index.mdrename to docs/api/atomic_agents/lib/utils/index.mddiff --git a/docs/atomic_agents/lib/utils/logger.md b/docs/api/atomic_agents/lib/utils/logger.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/logger.mdrename to docs/api/atomic_agents/lib/utils/logger.mddiff --git a/docs/atomic_agents/lib/utils/scraping/index.md b/docs/api/atomic_agents/lib/utils/scraping/index.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/scraping/index.mdrename to docs/api/atomic_agents/lib/utils/scraping/index.mddiff --git a/docs/atomic_agents/lib/utils/scraping/pdf_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/scraping/pdf_to_markdown.mdrename to docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.mddiff --git a/docs/atomic_agents/lib/utils/scraping/url_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.mdsimilarity index 100%rename from docs/atomic_agents/lib/utils/scraping/url_to_markdown.mdrename to docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md