mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-07 15:18:29 +00:00
dfc4255f2f
* docs: Fix major memory system documentation issues - Remove misleading deprecation warnings, fix confusing comments, clearly separate three memory approaches, provide accurate examples that match implementation * fix: Correct broken image paths in README - Update crewai_logo.png and asset.png paths to point to docs/images/ directory instead of docs/ directly * docs: Add system prompt transparency and customization guide - Add 'Understanding Default System Instructions' section to address black-box concerns - Document what CrewAI automatically injects into prompts - Provide code examples to inspect complete system prompts - Show 3 methods to override default instructions - Include observability integration examples with Langfuse - Add best practices for production prompt management * docs: Fix implementation accuracy issues in memory documentation - Fix Ollama embedding URL parameter and remove unsupported Cohere input_type parameter * docs: Reference observability docs instead of showing specific tool examples * docs: Reorganize knowledge documentation for better developer experience - Move quickstart examples right after overview for immediate hands-on experience - Create logical learning progression: basics → configuration → advanced → troubleshooting - Add comprehensive agent vs crew knowledge guide with working examples - Consolidate debugging and troubleshooting in dedicated section - Organize best practices by topic in accordion format - Improve content flow from simple concepts to advanced features - Ensure all examples are grounded in actual codebase implementation * docs: enhance custom LLM documentation with comprehensive examples and accurate imports * docs: reorganize observability tools into dedicated section with comprehensive overview and improved navigation * docs: rename how-to section to learn and add comprehensive overview page * docs: finalize documentation reorganization and update navigation labels * docs: enhance README with comprehensive badges, navigation links, and getting started video
158 lines
6.3 KiB
Plaintext
158 lines
6.3 KiB
Plaintext
---
|
|
title: "Overview"
|
|
description: "Learn how to build, customize, and optimize your CrewAI applications with comprehensive guides and tutorials"
|
|
icon: "face-smile"
|
|
---
|
|
|
|
## Learn CrewAI
|
|
|
|
This section provides comprehensive guides and tutorials to help you master CrewAI, from basic concepts to advanced techniques. Whether you're just getting started or looking to optimize your existing implementations, these resources will guide you through every aspect of building powerful AI agent workflows.
|
|
|
|
## Getting Started Guides
|
|
|
|
### Core Concepts
|
|
<CardGroup cols={2}>
|
|
<Card title="Sequential Process" icon="list-ol" href="/learn/sequential-process">
|
|
Learn how to execute tasks in a sequential order for structured workflows.
|
|
</Card>
|
|
|
|
<Card title="Hierarchical Process" icon="sitemap" href="/learn/hierarchical-process">
|
|
Implement hierarchical task execution with manager agents overseeing workflows.
|
|
</Card>
|
|
|
|
<Card title="Conditional Tasks" icon="code-branch" href="/learn/conditional-tasks">
|
|
Create dynamic workflows with conditional task execution based on outcomes.
|
|
</Card>
|
|
|
|
<Card title="Async Kickoff" icon="bolt" href="/learn/kickoff-async">
|
|
Execute crews asynchronously for improved performance and concurrency.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
### Agent Development
|
|
<CardGroup cols={2}>
|
|
<Card title="Customizing Agents" icon="user-gear" href="/learn/customizing-agents">
|
|
Learn how to customize agent behavior, roles, and capabilities.
|
|
</Card>
|
|
|
|
<Card title="Coding Agents" icon="code" href="/learn/coding-agents">
|
|
Build agents that can write, execute, and debug code automatically.
|
|
</Card>
|
|
|
|
<Card title="Multimodal Agents" icon="images" href="/learn/multimodal-agents">
|
|
Create agents that can process text, images, and other media types.
|
|
</Card>
|
|
|
|
<Card title="Custom Manager Agent" icon="user-tie" href="/learn/custom-manager-agent">
|
|
Implement custom manager agents for complex hierarchical workflows.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Advanced Features
|
|
|
|
### Workflow Control
|
|
<CardGroup cols={2}>
|
|
<Card title="Human in the Loop" icon="user-check" href="/learn/human-in-the-loop">
|
|
Integrate human oversight and intervention into agent workflows.
|
|
</Card>
|
|
|
|
<Card title="Human Input on Execution" icon="hand-paper" href="/learn/human-input-on-execution">
|
|
Allow human input during task execution for dynamic decision making.
|
|
</Card>
|
|
|
|
<Card title="Replay Tasks" icon="rotate-left" href="/learn/replay-tasks-from-latest-crew-kickoff">
|
|
Replay and resume tasks from previous crew executions.
|
|
</Card>
|
|
|
|
<Card title="Kickoff for Each" icon="repeat" href="/learn/kickoff-for-each">
|
|
Execute crews multiple times with different inputs efficiently.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
### Customization & Integration
|
|
<CardGroup cols={2}>
|
|
<Card title="Custom LLM" icon="brain" href="/learn/custom-llm">
|
|
Integrate custom language models and providers with CrewAI.
|
|
</Card>
|
|
|
|
<Card title="LLM Connections" icon="link" href="/learn/llm-connections">
|
|
Configure and manage connections to various LLM providers.
|
|
</Card>
|
|
|
|
<Card title="Create Custom Tools" icon="wrench" href="/learn/create-custom-tools">
|
|
Build custom tools to extend agent capabilities.
|
|
</Card>
|
|
|
|
<Card title="Using Annotations" icon="at" href="/learn/using-annotations">
|
|
Use Python annotations for cleaner, more maintainable code.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Specialized Applications
|
|
|
|
### Content & Media
|
|
<CardGroup cols={2}>
|
|
<Card title="DALL-E Image Generation" icon="image" href="/learn/dalle-image-generation">
|
|
Generate images using DALL-E integration with your agents.
|
|
</Card>
|
|
|
|
<Card title="Bring Your Own Agent" icon="user-plus" href="/learn/bring-your-own-agent">
|
|
Integrate existing agents and models into CrewAI workflows.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
### Tool Management
|
|
<CardGroup cols={2}>
|
|
<Card title="Force Tool Output as Result" icon="hammer" href="/learn/force-tool-output-as-result">
|
|
Configure tools to return their output directly as task results.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Learning Path Recommendations
|
|
|
|
### For Beginners
|
|
1. Start with **Sequential Process** to understand basic workflow execution
|
|
2. Learn **Customizing Agents** to create effective agent configurations
|
|
3. Explore **Create Custom Tools** to extend functionality
|
|
4. Try **Human in the Loop** for interactive workflows
|
|
|
|
### For Intermediate Users
|
|
1. Master **Hierarchical Process** for complex multi-agent systems
|
|
2. Implement **Conditional Tasks** for dynamic workflows
|
|
3. Use **Async Kickoff** for performance optimization
|
|
4. Integrate **Custom LLM** for specialized models
|
|
|
|
### For Advanced Users
|
|
1. Build **Multimodal Agents** for complex media processing
|
|
2. Create **Custom Manager Agents** for sophisticated orchestration
|
|
3. Implement **Bring Your Own Agent** for hybrid systems
|
|
4. Use **Replay Tasks** for robust error recovery
|
|
|
|
## Best Practices
|
|
|
|
### Development
|
|
- **Start Simple**: Begin with basic sequential workflows before adding complexity
|
|
- **Test Incrementally**: Test each component before integrating into larger systems
|
|
- **Use Annotations**: Leverage Python annotations for cleaner, more maintainable code
|
|
- **Custom Tools**: Build reusable tools that can be shared across different agents
|
|
|
|
### Production
|
|
- **Error Handling**: Implement robust error handling and recovery mechanisms
|
|
- **Performance**: Use async execution and optimize LLM calls for better performance
|
|
- **Monitoring**: Integrate observability tools to track agent performance
|
|
- **Human Oversight**: Include human checkpoints for critical decisions
|
|
|
|
### Optimization
|
|
- **Resource Management**: Monitor and optimize token usage and API costs
|
|
- **Workflow Design**: Design workflows that minimize unnecessary LLM calls
|
|
- **Tool Efficiency**: Create efficient tools that provide maximum value with minimal overhead
|
|
- **Iterative Improvement**: Use feedback and metrics to continuously improve agent performance
|
|
|
|
## Getting Help
|
|
|
|
- **Documentation**: Each guide includes detailed examples and explanations
|
|
- **Community**: Join the [CrewAI Forum](https://community.crewai.com) for discussions and support
|
|
- **Examples**: Check the Examples section for complete working implementations
|
|
- **Support**: Contact [support@crewai.com](mailto:support@crewai.com) for technical assistance
|
|
|
|
Start with the guides that match your current needs and gradually explore more advanced topics as you become comfortable with the fundamentals. |