mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
93dafe2637
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
160 lines
6.4 KiB
Plaintext
160 lines
6.4 KiB
Plaintext
---
|
|
title: "Overview"
|
|
description: "Learn how to build, customize, and optimize your CrewAI applications with comprehensive guides and tutorials"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
## 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="/en/learn/sequential-process">
|
|
Learn how to execute tasks in a sequential order for structured workflows.
|
|
</Card>
|
|
|
|
<Card title="Hierarchical Process" icon="sitemap" href="/en/learn/hierarchical-process">
|
|
Implement hierarchical task execution with manager agents overseeing workflows.
|
|
</Card>
|
|
|
|
<Card title="Conditional Tasks" icon="code-branch" href="/en/learn/conditional-tasks">
|
|
Create dynamic workflows with conditional task execution based on outcomes.
|
|
</Card>
|
|
|
|
<Card title="Async Kickoff" icon="bolt" href="/en/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="/en/learn/customizing-agents">
|
|
Learn how to customize agent behavior, roles, and capabilities.
|
|
</Card>
|
|
|
|
<Card title="Coding Agents" icon="code" href="/en/learn/coding-agents">
|
|
Build agents that can write, execute, and debug code automatically.
|
|
</Card>
|
|
|
|
<Card title="Multimodal Agents" icon="images" href="/en/learn/multimodal-agents">
|
|
Create agents that can process text, images, and other media types.
|
|
</Card>
|
|
|
|
<Card title="Custom Manager Agent" icon="user-tie" href="/en/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="/en/learn/human-in-the-loop">
|
|
Integrate human oversight and intervention into agent workflows.
|
|
</Card>
|
|
|
|
<Card title="Human Input on Execution" icon="hand-paper" href="/en/learn/human-input-on-execution">
|
|
Allow human input during task execution for dynamic decision making.
|
|
</Card>
|
|
|
|
<Card title="Replay Tasks" icon="rotate-left" href="/en/learn/replay-tasks-from-latest-crew-kickoff">
|
|
Replay and resume tasks from previous crew executions.
|
|
</Card>
|
|
|
|
<Card title="Kickoff for Each" icon="repeat" href="/en/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="/en/learn/custom-llm">
|
|
Integrate custom language models and providers with CrewAI.
|
|
</Card>
|
|
|
|
<Card title="LLM Connections" icon="link" href="/en/learn/llm-connections">
|
|
Configure and manage connections to various LLM providers.
|
|
</Card>
|
|
|
|
<Card title="Create Custom Tools" icon="wrench" href="/en/learn/create-custom-tools">
|
|
Build custom tools to extend agent capabilities.
|
|
</Card>
|
|
|
|
<Card title="Using Annotations" icon="at" href="/en/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="/en/learn/dalle-image-generation">
|
|
Generate images using DALL-E integration with your agents.
|
|
</Card>
|
|
|
|
<Card title="Bring Your Own Agent" icon="user-plus" href="/en/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="/en/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.
|