starting to revamp docs

This commit is contained in:
João Moura
2024-01-10 13:10:48 -03:00
parent feafa586ae
commit 34c1c0d76a
8 changed files with 11 additions and 18 deletions

View File

@@ -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)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 431 KiB

BIN
docs/crewAI-mindmap.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 427 KiB

View File

Before

Width:  |  Height:  |  Size: 97 KiB

After

Width:  |  Height:  |  Size: 97 KiB

0
docs/examples.md Normal file
View File

0
docs/getting-started.md Normal file
View File

View File

@@ -1,17 +1,8 @@
# Welcome to MkDocs
<img src='./crewai_logo.png' width='250'/>
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.
<p align="center">
<img src='./crewAI-mindmap.png' />
</p>

View File

@@ -4,4 +4,6 @@ theme:
palette:
scheme: default
primary: red
accent: red
accent: red
features:
- navigation.tabs