diff --git a/README.md b/README.md index c90d8d948..f04897f66 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # crewAI -![Logo of crewAI, tow people rowing on a boat](./crewai_logo.png) +![Logo of crewAI, tow people rowing on a boat](./docs/crewai_logo.png) 🤖 Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. @@ -127,7 +127,7 @@ Currently the only supported process is `Process.sequential`, where one task is - **Flexible Task Management**: Define tasks with customizable tools and assign them to agents dynamically. - **Processes Driven**: Currently only supports `sequential` task execution but more complex processes like consensual and hierarchical being worked on. -![CrewAI Mind Map](/crewAI-mindmap.png "CrewAI Mind Map") +![CrewAI Mind Map](./docs/crewAI-mindmap.png "CrewAI Mind Map") ## Examples You can test different real life examples of AI crews [in the examples repo](https://github.com/joaomdmoura/crewAI-examples?tab=readme-ov-file) diff --git a/crewAI-mindmap.png b/crewAI-mindmap.png deleted file mode 100644 index 4d7abd4cc..000000000 Binary files a/crewAI-mindmap.png and /dev/null differ diff --git a/docs/crewAI-mindmap.png b/docs/crewAI-mindmap.png new file mode 100644 index 000000000..bbad33bed Binary files /dev/null and b/docs/crewAI-mindmap.png differ diff --git a/crewai_logo.png b/docs/crewai_logo.png similarity index 100% rename from crewai_logo.png rename to docs/crewai_logo.png diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/index.md b/docs/index.md index 000ea3455..22f67bf97 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,8 @@ -# Welcome to MkDocs + -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +# Welcome to crewAI Documentation +🤖 Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +

+ +

\ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b210c1e7f..c65498bb6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,4 +4,6 @@ theme: palette: scheme: default primary: red - accent: red \ No newline at end of file + accent: red + features: + - navigation.tabs \ No newline at end of file