mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
* feat: adopt directory-based docs versioning with Edge channel 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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
155 lines
5.4 KiB
Plaintext
155 lines
5.4 KiB
Plaintext
---
|
|
title: Planning
|
|
description: Learn how to add planning to your CrewAI Crew and improve their performance.
|
|
icon: ruler-combined
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
The planning feature in CrewAI allows you to add planning capability to your crew. When enabled, before each Crew iteration,
|
|
all Crew information is sent to an AgentPlanner that will plan the tasks step by step, and this plan will be added to each task description.
|
|
|
|
### Using the Planning Feature
|
|
|
|
Getting started with the planning feature is very easy, the only step required is to add `planning=True` to your Crew:
|
|
|
|
<CodeGroup>
|
|
```python Code
|
|
from crewai import Crew, Agent, Task, Process
|
|
|
|
# Assemble your crew with planning capabilities
|
|
my_crew = Crew(
|
|
agents=self.agents,
|
|
tasks=self.tasks,
|
|
process=Process.sequential,
|
|
planning=True,
|
|
)
|
|
```
|
|
</CodeGroup>
|
|
|
|
From this point on, your crew will have planning enabled, and the tasks will be planned before each iteration.
|
|
|
|
<Warning>
|
|
When planning is enabled, crewAI will use `gpt-4o-mini` as the default LLM for planning, which requires a valid OpenAI API key. Since your agents might be using different LLMs, this could cause confusion if you don't have an OpenAI API key configured or if you're experiencing unexpected behavior related to LLM API calls.
|
|
</Warning>
|
|
|
|
#### Planning LLM
|
|
|
|
Now you can define the LLM that will be used to plan the tasks.
|
|
|
|
When running the base case example, you will see something like the output below, which represents the output of the `AgentPlanner`
|
|
responsible for creating the step-by-step logic to add to the Agents' tasks.
|
|
|
|
<CodeGroup>
|
|
```python Code
|
|
from crewai import Crew, Agent, Task, Process
|
|
|
|
# Assemble your crew with planning capabilities and custom LLM
|
|
my_crew = Crew(
|
|
agents=self.agents,
|
|
tasks=self.tasks,
|
|
process=Process.sequential,
|
|
planning=True,
|
|
planning_llm="gpt-4o"
|
|
)
|
|
|
|
# Run the crew
|
|
my_crew.kickoff()
|
|
```
|
|
|
|
```markdown Result
|
|
[2024-07-15 16:49:11][INFO]: Planning the crew execution
|
|
**Step-by-Step Plan for Task Execution**
|
|
|
|
**Task Number 1: Conduct a thorough research about AI LLMs**
|
|
|
|
**Agent:** AI LLMs Senior Data Researcher
|
|
|
|
**Agent Goal:** Uncover cutting-edge developments in AI LLMs
|
|
|
|
**Task Expected Output:** A list with 10 bullet points of the most relevant information about AI LLMs
|
|
|
|
**Task Tools:** None specified
|
|
|
|
**Agent Tools:** None specified
|
|
|
|
**Step-by-Step Plan:**
|
|
|
|
1. **Define Research Scope:**
|
|
|
|
- Determine the specific areas of AI LLMs to focus on, such as advancements in architecture, use cases, ethical considerations, and performance metrics.
|
|
|
|
2. **Identify Reliable Sources:**
|
|
|
|
- List reputable sources for AI research, including academic journals, industry reports, conferences (e.g., NeurIPS, ACL), AI research labs (e.g., OpenAI, Google AI), and online databases (e.g., IEEE Xplore, arXiv).
|
|
|
|
3. **Collect Data:**
|
|
|
|
- Search for the latest papers, articles, and reports published in 2024 and early 2025.
|
|
- Use keywords like "Large Language Models 2025", "AI LLM advancements", "AI ethics 2025", etc.
|
|
|
|
4. **Analyze Findings:**
|
|
|
|
- Read and summarize the key points from each source.
|
|
- Highlight new techniques, models, and applications introduced in the past year.
|
|
|
|
5. **Organize Information:**
|
|
|
|
- Categorize the information into relevant topics (e.g., new architectures, ethical implications, real-world applications).
|
|
- Ensure each bullet point is concise but informative.
|
|
|
|
6. **Create the List:**
|
|
|
|
- Compile the 10 most relevant pieces of information into a bullet point list.
|
|
- Review the list to ensure clarity and relevance.
|
|
|
|
**Expected Output:**
|
|
|
|
A list with 10 bullet points of the most relevant information about AI LLMs.
|
|
|
|
---
|
|
|
|
**Task Number 2: Review the context you got and expand each topic into a full section for a report**
|
|
|
|
**Agent:** AI LLMs Reporting Analyst
|
|
|
|
**Agent Goal:** Create detailed reports based on AI LLMs data analysis and research findings
|
|
|
|
**Task Expected Output:** A fully fledged report with the main topics, each with a full section of information. Formatted as markdown without '```'
|
|
|
|
**Task Tools:** None specified
|
|
|
|
**Agent Tools:** None specified
|
|
|
|
**Step-by-Step Plan:**
|
|
|
|
1. **Review the Bullet Points:**
|
|
- Carefully read through the list of 10 bullet points provided by the AI LLMs Senior Data Researcher.
|
|
|
|
2. **Outline the Report:**
|
|
- Create an outline with each bullet point as a main section heading.
|
|
- Plan sub-sections under each main heading to cover different aspects of the topic.
|
|
|
|
3. **Research Further Details:**
|
|
- For each bullet point, conduct additional research if necessary to gather more detailed information.
|
|
- Look for case studies, examples, and statistical data to support each section.
|
|
|
|
4. **Write Detailed Sections:**
|
|
- Expand each bullet point into a comprehensive section.
|
|
- Ensure each section includes an introduction, detailed explanation, examples, and a conclusion.
|
|
- Use markdown formatting for headings, subheadings, lists, and emphasis.
|
|
|
|
5. **Review and Edit:**
|
|
- Proofread the report for clarity, coherence, and correctness.
|
|
- Make sure the report flows logically from one section to the next.
|
|
- Format the report according to markdown standards.
|
|
|
|
6. **Finalize the Report:**
|
|
- Ensure the report is complete with all sections expanded and detailed.
|
|
- Double-check formatting and make any necessary adjustments.
|
|
|
|
**Expected Output:**
|
|
A fully fledged report with the main topics, each with a full section of information. Formatted as markdown without '```'.
|
|
```
|
|
</CodeGroup> |