Add docs redirects and development tools (#3096)

* Add Reo.dev tracking script to documentation * Comprehensive docs improvements and development tools - Add comprehensive .cursorrules with CrewAI and Flow development patterns - Add redirect rules for old doc links without /en/ prefix - Replace changelog pages with direct GitHub releases links - Fix installation page directory tree rendering issue - Fix broken Visual Studio Build Tools link formatting - Remove obsolete changelog files to reduce maintenance overhead These changes improve developer experience and ensure all old documentation links continue working.
2026-01-08 23:58:34 +00:00 · 2025-07-01 14:41:34 -04:00
parent e544ff8ba3
commit 640e1a7bc2
5 changed files with 1503 additions and 973 deletions
--- a/docs/en/changelog.mdx
+++ b/docs/en/changelog.mdx
@@ -1,473 +0,0 @@
---
-title: Changelog
-description: View the latest updates and changes to CrewAI
-icon: timeline
---
-
-<Update label="2024-05-22" description="v0.121.0" tags={["Latest"]}>
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01210.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.121.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Fixed encoding error when creating tools
-  - Fixed failing llama test
-  - Updated logging configuration for consistency
-  - Enhanced telemetry initialization and event handling
-
-  **New Features & Enhancements**
-  - Added **markdown attribute** to the Task class
-  - Added **reasoning attribute** to the Agent class
-  - Added **inject_date flag** to Agent for automatic date injection
-  - Implemented **HallucinationGuardrail** (no-op with test coverage)
-
-  **Documentation & Guides**
-  - Added documentation for **StagehandTool** and improved MDX structure
-  - Added documentation for **MCP integration** and updated enterprise docs
-  - Documented knowledge events and updated reasoning docs
-  - Added stop parameter documentation
-  - Fixed import references in doc examples (before_kickoff, after_kickoff)
-  - General docs updates and restructuring for clarity
-</Update>
-
-<Update label="2024-05-15" description="v0.120.1">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01201.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.120.1">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Fixed **interpolation with hyphens**
-</Update>
-
-<Update label="2024-05-14" description="v0.120.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01200.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.120.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Enabled **full Ruff rule set** by default for stricter linting
-  - Addressed race condition in FilteredStream using context managers
-  - Fixed agent knowledge reset issue
-  - Refactored agent fetching logic into utility module
-
-  **New Features & Enhancements**
-  - Added support for **loading an Agent directly from a repository**
-  - Enabled setting an empty context for Task
-  - Enhanced Agent repository feedback and fixed Tool auto-import behavior
-  - Introduced direct initialization of knowledge (bypassing knowledge_sources)
-
-  **Documentation & Guides**
-  - Updated security.md for current security practices
-  - Cleaned up Google setup section for clarity
-  - Added link to AI Studio when entering Gemini key
-  - Updated Arize Phoenix observability guide
-  - Refreshed flow documentation
-</Update>
-
-<Update label="2024-05-08" description="v0.119.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01190.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.119.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Improved test reliability by enhancing pytest handling for flaky tests
-  - Fixed memory reset crash when embedding dimensions mismatch
-  - Enabled parent flow identification for Crew and LiteAgent
-  - Prevented telemetry-related crashes when unavailable
-  - Upgraded **LiteLLM version** for better compatibility
-  - Fixed llama converter tests by removing skip_external_api
-
-  **New Features & Enhancements**
-  - Introduced **knowledge retrieval prompt re-writing** in Agent for improved tracking and debugging
-  - Made LLM setup and quickstart guides model-agnostic
-
-  **Documentation & Guides**
-  - Added advanced configuration docs for the RAG tool
-  - Updated Windows troubleshooting guide
-  - Refined documentation examples for better clarity
-  - Fixed typos across docs and config files
-</Update>
-
-<Update label="2024-04-28" description="v0.118.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01180.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.118.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Fixed issues with missing prompt or system templates
-  - Removed global logging configuration to avoid unintended overrides
-  - Renamed **TaskGuardrail to LLMGuardrail** for improved clarity
-  - Downgraded litellm to version 1.167.1 for compatibility
-  - Added missing init.py files to ensure proper module initialization
-
-  **New Features & Enhancements**
-  - Added support for **no-code Guardrail creation** to simplify AI behavior controls
-
-  **Documentation & Guides**
-  - Removed CrewStructuredTool from public documentation to reflect internal usage
-  - Updated enterprise documentation and YouTube embed for improved onboarding experience
-</Update>
-
-<Update label="2024-04-20" description="v0.117.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01170.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.117.0">View on GitHub</a>
-  </div>
-
-  **New Features & Enhancements**
-  - Added `result_as_answer` parameter support in `@tool` decorator.
-  - Introduced support for new language models: GPT-4.1, Gemini-2.0, and Gemini-2.5 Pro.
-  - Enhanced knowledge management capabilities.
-  - Added Huggingface provider option in CLI.
-  - Improved compatibility and CI support for Python 3.10+.
-
-  **Core Improvements & Fixes**
-  - Fixed issues with incorrect template parameters and missing inputs.
-  - Improved asynchronous flow handling with coroutine condition checks.
-  - Enhanced memory management with isolated configuration and correct memory object copying.
-  - Fixed initialization of lite agents with correct references.
-  - Addressed Python type hint issues and removed redundant imports.
-  - Updated event placement for improved tool usage tracking.
-  - Raised explicit exceptions when flows fail.
-  - Removed unused code and redundant comments from various modules.
-  - Updated GitHub App token action to v2.
-
-  **Documentation & Guides**
-  - Enhanced documentation structure, including enterprise deployment instructions.
-  - Automatically create output folders for documentation generation.
-  - Fixed broken link in WeaviateVectorSearchTool documentation.
-  - Fixed guardrail documentation usage and import paths for JSON search tools.
-  - Updated documentation for CodeInterpreterTool.
-  - Improved SEO, contextual navigation, and error handling for documentation pages.
-</Update>
-
-<Update label="2024-04-25" description="v0.117.1">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01171.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.117.1">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Upgraded **crewai-tools** to latest version
-  - Upgraded **liteLLM** to latest version
-  - Fixed **Mem0 OSS**
-</Update>
-
-<Update label="2024-04-07" description="v0.114.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01140.png" />
-  </Frame>
-
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.114.0">View on GitHub</a>
-  </div>
-
-  **New Features & Enhancements**
-  - Agents as an atomic unit. (`Agent(...).kickoff()`)
-  - Support for [Custom LLM implementations](https://docs.crewai.com/guides/advanced/custom-llm).
-  - Integrated External Memory and [Opik observability](https://docs.crewai.com/how-to/opik-observability).
-  - Enhanced YAML extraction.
-  - Multimodal agent validation.
-  - Added Secure fingerprints for agents and crews.
-
-  **Core Improvements & Fixes**
-  - Improved serialization, agent copying, and Python compatibility.
-  - Added wildcard support to `emit()`
-  - Added support for additional router calls and context window adjustments.
-  - Fixed typing issues, validation, and import statements.
-  - Improved method performance.
-  - Enhanced agent task handling, event emissions, and memory management.
-  - Fixed CLI issues, conditional tasks, cloning behavior, and tool outputs.
-
-  **Documentation & Guides**
-  - Improved documentation structure, theme, and organization.
-  - Added guides for Local NVIDIA NIM with WSL2, W&B Weave, and Arize Phoenix.
-  - Updated tool configuration examples, prompts, and observability docs.
-  - Guide on using singular agents within Flows.
-</Update>
-
-<Update label="2024-03-17" description="v0.108.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01080.png" />
-  </Frame>
-
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.108.0">View on GitHub</a>
-  </div>
-
-  **New Features & Enhancements**
-  - Converted tabs to spaces in `crew.py` template
-  - Enhanced LLM Streaming Response Handling and Event System
-  - Included `model_name`
-  - Enhanced Event Listener with rich visualization and improved logging
-  - Added fingerprints
-
-  **Bug Fixes**
-  - Fixed Mistral issues
-  - Fixed a bug in documentation
-  - Fixed type check error in fingerprint property
-
-  **Documentation Updates**
-  - Improved tool documentation
-  - Updated installation guide for the `uv` tool package
-  - Added instructions for upgrading crewAI with the `uv` tool
-  - Added documentation for `ApifyActorsTool`
-</Update>
-
-<Update label="2024-03-10" description="v0.105.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01050.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.105.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Fixed issues with missing template variables and user memory configuration
-  - Improved async flow support and addressed agent response formatting
-  - Enhanced memory reset functionality and fixed CLI memory commands
-  - Fixed type issues, tool calling properties, and telemetry decoupling
-
-  **New Features & Enhancements**
-  - Added Flow state export and improved state utilities
-  - Enhanced agent knowledge setup with optional crew embedder
-  - Introduced event emitter for better observability and LLM call tracking
-  - Added support for Python 3.10 and ChatOllama from langchain_ollama
-  - Integrated context window size support for the o3-mini model
-  - Added support for multiple router calls
-
-  **Documentation & Guides**
-  - Improved documentation layout and hierarchical structure
-  - Added QdrantVectorSearchTool guide and clarified event listener usage
-  - Fixed typos in prompts and updated Amazon Bedrock model listings
-</Update>
-
-<Update label="2024-02-12" description="v0.102.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01020.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.102.0">View on GitHub</a>
-  </div>
-
-  **Core Improvements & Fixes**
-  - Enhanced LLM Support: Improved structured LLM output, parameter handling, and formatting for Anthropic models
-  - Crew & Agent Stability: Fixed issues with cloning agents/crews using knowledge sources, multiple task outputs in conditional tasks, and ignored Crew task callbacks
-  - Memory & Storage Fixes: Fixed short-term memory handling with Bedrock, ensured correct embedder initialization, and added a reset memories function in the crew class
-  - Training & Execution Reliability: Fixed broken training and interpolation issues with dict and list input types
-
-  **New Features & Enhancements**
-  - Advanced Knowledge Management: Improved naming conventions and enhanced embedding configuration with custom embedder support
-  - Expanded Logging & Observability: Added JSON format support for logging and integrated MLflow tracing documentation
-  - Data Handling Improvements: Updated excel_knowledge_source.py to process multi-tab files
-  - General Performance & Codebase Clean-Up: Streamlined enterprise code alignment and resolved linting issues
-  - Adding new tool: `QdrantVectorSearchTool`
-
-  **Documentation & Guides**
-  - Updated AI & Memory Docs: Improved Bedrock, Google AI, and long-term memory documentation
-  - Task & Workflow Clarity: Added "Human Input" row to Task Attributes, Langfuse guide, and FileWriterTool documentation
-  - Fixed Various Typos & Formatting Issues
-</Update>
-
-<Update label="2024-01-28" description="v0.100.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v01000.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.100.0">View on GitHub</a>
-  </div>
-
-  **Features**
-  - Add Composio docs
-  - Add SageMaker as a LLM provider
-  
-  **Fixes**
-  - Overall LLM connection issues
-  - Using safe accessors on training
-  - Add version check to crew_chat.py
-  
-  **Documentation**
-  - New docs for crewai chat
-  - Improve formatting and clarity in CLI and Composio Tool docs
-</Update>
-
-<Update label="2024-01-20" description="v0.98.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v0980.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.98.0">View on GitHub</a>
-  </div>
-
-  **Features**
-  - Conversation crew v1
-  - Add unique ID to flow states
-  - Add @persist decorator with FlowPersistence interface
-  
-  **Integrations**
-  - Add SambaNova integration
-  - Add NVIDIA NIM provider in cli
-  - Introducing VoyageAI
-  
-  **Fixes**
-  - Fix API Key Behavior and Entity Handling in Mem0 Integration
-  - Fixed core invoke loop logic and relevant tests
-  - Make tool inputs actual objects and not strings
-  - Add important missing parts to creating tools
-  - Drop litellm version to prevent windows issue
-  - Before kickoff if inputs are none
-  - Fixed typos, nested pydantic model issue, and docling issues
-</Update>
-
-<Update label="2024-01-04" description="v0.95.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v0950.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.95.0">View on GitHub</a>
-  </div>
-
-  **New Features**
-  - Adding Multimodal Abilities to Crew
-  - Programatic Guardrails
-  - HITL multiple rounds
-  - Gemini 2.0 Support
-  - CrewAI Flows Improvements
-  - Add Workflow Permissions
-  - Add support for langfuse with litellm
-  - Portkey Integration with CrewAI
-  - Add interpolate_only method and improve error handling
-  - Docling Support
-  - Weviate Support
-  
-  **Fixes**
-  - output_file not respecting system path
-  - disk I/O error when resetting short-term memory
-  - CrewJSONEncoder now accepts enums
-  - Python max version
-  - Interpolation for output_file in Task
-  - Handle coworker role name case/whitespace properly
-  - Add tiktoken as explicit dependency and document Rust requirement
-  - Include agent knowledge in planning process
-  - Change storage initialization to None for KnowledgeStorage
-  - Fix optional storage checks
-  - include event emitter in flows
-  - Docstring, Error Handling, and Type Hints Improvements
-  - Suppressed userWarnings from litellm pydantic issues
-</Update>
-
-<Update label="2024-12-05" description="v0.86.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v0860.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.86.0">View on GitHub</a>
-  </div>
-  **Changes**
-  - Remove all references to pipeline and pipeline router
-  - Add Nvidia NIM as provider in Custom LLM
-  - Add knowledge demo + improve knowledge docs
-  - Add HITL multiple rounds of followup
-  - New docs about yaml crew with decorators
-  - Simplify template crew
-</Update>
-
-<Update label="2024-12-04" description="v0.85.0">
-  ## Release Highlights
-  <Frame>
-    <img src="/images/releases/v0850.png" />
-  </Frame>
-  
-  <div style={{ textAlign: 'center', marginBottom: '1rem' }}>
-    <a href="https://github.com/crewAIInc/crewAI/releases/tag/0.85.0">View on GitHub</a>
-  </div>
-  **Features**
-  - Added knowledge to agent level
-  - Feat/remove langchain
-  - Improve typed task outputs
-  - Log in to Tool Repository on crewai login
-  
-  **Fixes**
-  - Fixes issues with result as answer not properly exiting LLM loop
-  - Fix missing key name when running with ollama provider
-  - Fix spelling issue found
-  
-  **Documentation**
-  - Update readme for running mypy
-  - Add knowledge to mint.json
-  - Update Github actions
-  - Update Agents docs to include two approaches for creating an agent
-  - Improvements to LLM Configuration and Usage
-</Update>
-
-<Update label="2024-11-25" description="v0.83.0">
-  **New Features**
-  - New before_kickoff and after_kickoff crew callbacks
-  - Support to pre-seed agents with Knowledge
-  - Add support for retrieving user preferences and memories using Mem0
-  
-  **Fixes**
-  - Fix Async Execution
-  - Upgrade chroma and adjust embedder function generator
-  - Update CLI Watson supported models + docs
-  - Reduce level for Bandit
-  - Fixing all tests
-  
-  **Documentation**
-  - Update Docs
-</Update>
-
-<Update label="2024-11-13" description="v0.80.0">
-  **Fixes**
-  - Fixing Tokens callback replacement bug
-  - Fixing Step callback issue
-  - Add cached prompt tokens info on usage metrics
-  - Fix crew_train_success test
-</Update>
--- a/docs/en/installation.mdx
+++ b/docs/en/installation.mdx
@@ -72,7 +72,7 @@ If you haven't installed `uv` yet, follow **step 1** to quickly get it set up on
          </Warning>

          <Warning>
-            If you encounter the `chroma-hnswlib==0.7.6` build error (`fatal error C1083: Cannot open include file: 'float.h'`) on Windows, install (Visual Studio Build Tools)[https://visualstudio.microsoft.com/downloads/] with *Desktop development with C++*.
+            If you encounter the `chroma-hnswlib==0.7.6` build error (`fatal error C1083: Cannot open include file: 'float.h'`) on Windows, install [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/) with *Desktop development with C++*.
          </Warning>

      - To verify that `crewai` is installed, run:
@@ -104,7 +104,6 @@ We recommend using the `YAML` template scaffolding for a structured approach to
      ```

    - This creates a new project with the following structure:
-      <Frame>
      ```
      my_project/
      ├── .gitignore
@@ -124,7 +123,6 @@ We recommend using the `YAML` template scaffolding for a structured approach to
                  ├── agents.yaml
                  └── tasks.yaml
      ```
-      </Frame>
  </Step>

  <Step title="Customize Your Project">