Fixing various typos in /docs #2855

didier-durand · 2025-05-18T14:31:43Z

Hi,

As per titles, fixing various typos in /docs. See commit diffs for details.

Best,

Didier

joaomdmoura · 2025-05-18T14:34:10Z

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment for PR #2855 - Documentation Typo Fixes

Overview

This pull request contains valuable documentation updates across seven files, significantly focusing on correcting typographical errors and enhancing the overall formatting of text. These changes serve to improve the user experience and understanding of the CrewAI framework.

File Analysis and Suggested Improvements

1. README.md

Identified Issue: An unexpected gti prefix before <div align="center"> and inconsistencies in spacing within markdown list items.
Recommendations:
- Remove the erroneous "gti" prefix.
- Standardize spacing post bullet points to enhance readability:
  - or_: Triggers when any of the specified conditions are met.
  - and_: Triggers when all specified conditions are met (ensure consistent spacing).

2. docs/concepts/knowledge.mdx

Identified Issue: Typos, inconsistency in line endings, and incorrect folder name ("knowldge" vs. "knowledge").
Recommendations:
- Fix the folder reference from "./knowldge folder" to "./knowledge folder".
- Standardize line endings and maintain consistent spacing after code blocks.

3. docs/concepts/llms.mdx

Identified Issue: Typo correction needed from "Qwen2 familly" to "Qwen2 family" and inconsistency in table formatting.
Recommendations:
- Correct the spelling error and standardize the table formatting.

4. docs/concepts/memory.mdx

Identified Issue: A typo "KNOWLEDEGE" needs correcting to "KNOWLEDGE", along with issues of inconsistent table formatting and trailing whitespace.
Recommendations:
- Fix the command line parameter description and standardize table formatting while removing extra whitespaces.

5. docs/examples/example.mdx

Identified Issue: Inconsistent job position text and trailing whitespace.
Recommendations:
- Correct text references from "jobpositions" to "job positions" and ensure the removal of trailing whitespace.

6. docs/how-to/arize-phoenix-observability.mdx

Identified Issue: Informal language ("wanna") should be replaced with a more professional term ("want to").
Recommendations:
- Revise comments for professionalism and consistent line endings.

7. docs/how-to/opik-observability.mdx

Identified Issue: Typo in "grab you API Key" should be corrected to "grab your API Key" and inconsistent markdown spacing.
Recommendations:
- Ensure proper pronoun use and standardize spacing between sections.

General Recommendations

Enforce consistent line endings (prefer LF).
Adopt a standard for all formatting including consistent spacing after headings and removal of trailing whitespaces.
Use precise and professional language throughout documentation.
Apply markdown best practices to maintain proper section spacing and list indentation.

Conclusion

The changes introduced in this PR are positive improvements and enhance the quality of documentation substantially, aiding both current users and future newcomers to the CrewAI framework. The aforementioned recommendations focus on refining consistency and professionalism, which are vital for maintaining high standards within our documentation.

Action Items

Remove the erroneous "gti" prefix in README.md.
Address all identified typos and spacing inconsistencies across documentation.
Standardize line endings and formatting throughout.
Remove trailing whitespace and revise informal language to professional alternatives.

Implementing these suggestions will bolster the documentation's clarity and user-friendliness, fostering a better understanding of CrewAI's capabilities.

lucasgomide · 2025-06-09T16:56:44Z

@didier-durand would you mind syncing your branch again?

* Add markdown attribute to Task class for formatting responses in Markdown Co-Authored-By: Joe Moura <joao@crewai.com> * Enhance markdown feature based on PR feedback Co-Authored-By: Joe Moura <joao@crewai.com> * Fix lint error and validation error in test_markdown_task.py Co-Authored-By: Joe Moura <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com>

* Add reasoning attribute to Agent class Co-Authored-By: Joe Moura <joao@crewai.com> * Address PR feedback: improve type hints, error handling, refactor reasoning handler, and enhance tests and docs Co-Authored-By: Joe Moura <joao@crewai.com> * Implement function calling for reasoning and move prompts to translations Co-Authored-By: Joe Moura <joao@crewai.com> * Simplify function calling implementation with better error handling Co-Authored-By: Joe Moura <joao@crewai.com> * Enhance system prompts to leverage agent context (role, goal, backstory) Co-Authored-By: Joe Moura <joao@crewai.com> * Fix lint and type-checker issues Co-Authored-By: Joe Moura <joao@crewai.com> * Enhance system prompts to better leverage agent context Co-Authored-By: Joe Moura <joao@crewai.com> * Fix backstory access in reasoning handler for Python 3.12 compatibility Co-Authored-By: Joe Moura <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com> Co-authored-by: João Moura <joaomdmoura@gmail.com>

…rewAIInc#2868)

This commit fixes a `UnicodeDecodeError` when creating tools. This was caused when reading template files.

* Add MCP integration documentation and update enterprise docs * Update MCP integration docs with code syntax improvements * Standardize documentation structure and add reasoning docs

…ewAIInc#2872)

* Refactor Crew class memory initialization and enhance event handling - Simplified the initialization of the external memory attribute in the Crew class. - Updated memory system retrieval logic for consistency in key usage. - Introduced a singleton pattern for the Telemetry class to ensure a single instance. - Replaced telemetry usage in CrewEvaluator with event bus emissions for test results. - Added new CrewTestResultEvent to handle crew test results more effectively. - Updated event listener to process CrewTestResultEvent and log telemetry data accordingly. - Enhanced tests to validate the singleton pattern in Telemetry and the new event handling logic. * linted * Remove unused telemetry attribute from Crew class memory initialization * fix ordering of test * Implement thread-safe singleton pattern in Telemetry class - Introduced a threading lock to ensure safe instantiation of the Telemetry singleton. - Updated the __new__ method to utilize double-checked locking for instance creation.

…#2869) - Add `HallucinationGuardrail` class as enterprise feature placeholder - Update LLM guardrail events to support `HallucinationGuardrail` instances - Add comprehensive tests for `HallucinationGuardrail` initialization and behavior - Add integration tests for `HallucinationGuardrail` with task execution system - Ensure no-op behavior always returns True

…#2870) * feat: Add inject_date flag to Agent for automatic date injection Co-Authored-By: Joe Moura <joao@crewai.com> * feat: Add date_format parameter and error handling to inject_date feature Co-Authored-By: Joe Moura <joao@crewai.com> * fix: Update test implementation for inject_date feature Co-Authored-By: Joe Moura <joao@crewai.com> * fix: Add date format validation to prevent invalid formats Co-Authored-By: Joe Moura <joao@crewai.com> * docs: Update documentation for inject_date feature Co-Authored-By: Joe Moura <joao@crewai.com> * unnecesary * new tests --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com> Co-authored-by: João Moura <joaomdmoura@gmail.com>

…ewAIInc#2878) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com>

…AIInc#2879)

* docs: enterprise hallucination guardrails Documents the `HallucinationGuardrail` feature for enterprise users, including usage examples, configuration options, and integration patterns. * fix: update import in the tin * chore: add docs.json route Add route for hallucination guardrail mdx

* Add crew name attribute to `CrewBase` annotated classes * Fix linting issue

…Inc#2891)

* init: support llama-api in crewAI * docs: add comments for clarity --------- Co-authored-by: Lucas Gomide <lucaslg200@gmail.com> Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>

* Add usage limit feature to BaseTool class - Add max_usage_count and current_usage_count attributes to BaseTool - Implement usage limit checking in ToolUsage._use method - Add comprehensive tests for usage limit functionality - Maintain backward compatibility with None default for unlimited usage Co-Authored-By: Joe Moura <joao@crewai.com> * Fix CI failures and address code review feedback - Add max_usage_count/current_usage_count to CrewStructuredTool - Add input validation for positive max_usage_count - Add reset_usage_count method to BaseTool - Extract usage limit check into separate method - Add comprehensive edge case tests - Add proper type hints throughout - Fix linting issues Co-Authored-By: Joe Moura <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com>

…IInc#2902) * 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

…ewAIInc#2921) This commit includes several enhancements to the MCP integration guide: - Adds a section on connecting to multiple MCP servers with a runnable example. - Ensures consistent mention and examples for Streamable HTTP transport. - Adds a manual lifecycle example for Streamable HTTP. - Clarifies Stdio command examples. - Refines definitions of Stdio, SSE, and Streamable HTTP transports. - Simplifies comments in code examples for clarity.

Added 'Multi-AI Agent' phrase for giving more clarity to key features section in clause 3 in README.md

* ci: support python 3.13 on CI * docs: update docs about support python version * build: adds requires python <3.14 * build: explicit tokenizers dependency Added explicit tokenizers dependency: Added tokenizers>=0.20.3 to ensure a version compatible with Python 3.13 is used. * build: drop fastembed is not longer used * build: attempt to build PyTorch on Python 3.13 * feat: upgrade fastavro, pyarrow and lancedb * build: ensure tiktoken greather than 0.8.0 due Python 3.13 compatibility

* feat: add capability to see and expose public Tool classes * feat: persist available Tools from repository on publish * ci: ignore explictly templates from ruff check Ruff only applies --exclude to files it discovers itself. So we have to skip manually the same files excluded from `ruff.toml` * sytle: fix linter issues * refactor: renaming available_tools_classes by available_exports * feat: provide more context about exportable tools * feat: allow to install a Tool from pypi * test: fix tests * feat: add env_vars attribute to BaseTool * remove TODO: security check since we are handle that on enterprise side

…2940) Previously, we only supported tools from the crewai-tools open-source repository. Now, we're introducing improved support for private tool repositories.

* fix: fix tool publisher logger when available_exports is found * docs: update docs and templates since we support Python 3.13

…d llm selection guide (crewAIInc#2959)

… files (crewAIInc#2961)

We are currently inserting tool results into LLM messages twice, which may unnecessarily increase processing costs, especially for longer outputs.

…wAIInc#2965) * docs: add minimum UV version required to use the Tool repository * docs: remove memory from Agent docs The Agent does not support `memory` attribute

- Add basic usage example showing guardrail uses task's expected_output as default context - Add explicit context example for custom reference content

* Increasing the default X-axis spacing for flow plotting * removing unused imports

* feat: support to list, switch and see your current organization * feat: store the current org after logged in * feat: filtering agents, tools and their actions by organization_uuid if present * fix linter offenses * refactor: propagate the current org thought Header instead of params * refactor: rename org column name to ID instead of Handle --------- Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>

* docs: added Maxim support for Agent Observability * enhanced the maxim integration doc page as per the github PR reviewer bot suggestions * Update maxim-observability.mdx * Update maxim-observability.mdx - Fixed Python version, >=3.10 - added expected_output field in Task - Removed marketing links and added github link * added maxim in observability --------- Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>

Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>

…c#2980) * docs: add organization management in our CLI docs * feat: improve user feedback when user is not authenticated * feat: improve logging about current organization while publishing/install a Tool * feat: improve logging when Agent repository is not found during fetch * fix linter offences * test: fix auth token error

…es (crewAIInc#2981) - Introduced a new documentation file for Integrations, detailing supported services and setup instructions. - Updated the main docs.json to include the new "integrations" feature in the contextual options. - Added several images related to integrations to enhance the documentation. Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>

…IInc#2848) * fix(metrics): prevent usage_metrics from dropping manager_agent tokens * Add test to verify hierarchical kickoff aggregates manager and agent usage metrics --------- Co-authored-by: Lucas Gomide <lucaslg200@gmail.com>

Co-authored-by: Lucas Gomide <lucaslg200@gmail.com>

* test: fix structured tool tests No tests were being executed from this file * feat: support to run async tool Some Tool requires async execution. This commit allow us to collect tool result from coroutines * docs: add docs about asynchronous tool support

…nc#2987) This correctly reflects support for all 3.13.x patch version

* feat: add guardrail support for Agents when using direct kickoff calls * refactor: expose guardrail func in a proper utils file * fix: resolve Self import on python 3.10

…les (crewAIInc#2946) * Fix telemetry singleton pattern to respect dynamic environment variables - Modified Telemetry.__init__ to prevent re-initialization with _initialized flag - Updated _safe_telemetry_operation to check _is_telemetry_disabled() dynamically - Added comprehensive tests for environment variables set after singleton creation - Fixed singleton contamination in existing tests by adding proper reset - Resolves issue crewAIInc#2945 where CREWAI_DISABLE_TELEMETRY=true was ignored when set after import Co-Authored-By: João <joao@crewai.com> * Implement code review improvements - Move _initialized flag to __new__ method for better encapsulation - Add type hints to _safe_telemetry_operation method - Consolidate telemetry execution checks into _should_execute_telemetry helper - Add pytest fixtures to reduce test setup redundancy - Enhanced documentation for singleton behavior Co-Authored-By: João <joao@crewai.com> * Fix mypy type-checker errors - Add explicit bool type annotation to _initialized field - Fix return value in task_started method to not return _safe_telemetry_operation result - Simplify initialization logic to set _initialized once in __init__ Co-Authored-By: João <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: João <joao@crewai.com> Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>

…wAIInc#2994) * Fix issue 2993: Prevent Flow status logs from hiding human input - Add pause_live_updates() and resume_live_updates() methods to ConsoleFormatter - Modify _ask_human_input() to pause Flow status updates during human input - Add comprehensive tests for pause/resume functionality and integration - Ensure Live session is properly managed during human input prompts - Fix prevents Flow status logs from overwriting user input prompts Fixes crewAIInc#2993 Co-Authored-By: João <joao@crewai.com> * Fix lint: Remove unused pytest import - Remove unused pytest import from test_console_formatter_pause_resume.py - Fixes F401 lint error identified in CI Co-Authored-By: João <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: João <joao@crewai.com>

…ock (crewAIInc#3002) - Bump CrewAI version from 0.126.0 to 0.130.0 in pyproject.toml and uv.lock. - Update optional dependency 'crewai-tools' version from 0.46.0 to 0.47.1. - Adjust dependency specifications in CLI templates to reflect the new version.

Fixing various typos in /docs

085d7af

applied further fixes based on initial review by agent

3f38188

devin-ai-integration bot and others added 26 commits June 12, 2025 16:31

fixing handler

d1eabf8

reasoning logs

cd5373e

docs: add MCP integration documentation and update enterprise docs (c…

11cf72a

…rewAIInc#2868)

Fix encoding error when creating tools (crewAIInc#2876)

790a003

This commit fixes a `UnicodeDecodeError` when creating tools. This was caused when reading template files.

Reasoning docs update (crewAIInc#2871)

78ff5c9

* Add MCP integration documentation and update enterprise docs * Update MCP integration docs with code syntax improvements * Standardize documentation structure and add reasoning docs

Document knowledge events in event-listener.mdx and knowledge.mdx (cr…

583fbe1

…ewAIInc#2872)

Updating Logging (crewAIInc#2874)

f08eec9

Fix imports for before_kickoff and after_kickoff in documentation (cr…

4c53984

…ewAIInc#2878) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com>

Update version to 0.121.0 across project files and dependencies (crew…

2d6bf7b

…AIInc#2879)

Add crew name attribute to CrewBase annotated classes (crewAIInc#2890)

7c42d06

* Add crew name attribute to `CrewBase` annotated classes * Fix linting issue

docs: update agent and task documentation with new parameters (crewAI…

22cad2f

…Inc#2891)

fix llm guardrail import and docs

f6616bb

logs

1c277be

Support Llama API in crewAI (crewAIInc#2825)

816c4e8

* init: support llama-api in crewAI * docs: add comments for clarity --------- Co-authored-by: Lucas Gomide <lucaslg200@gmail.com> Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>

docs: major docs updates (crewAIInc#2897)

68cd19e

improviong reasoning prompt

ef1e65e

remove unnecesary imrpots

2a06330

fixing

d04fc97

tonykipkemboi and others added 30 commits June 12, 2025 16:32

Expand MCP Integration documentation structure (crewAIInc#2922)

b40dd0c

Update README.md (crewAIInc#2923)

1a4ca3e

Added 'Multi-AI Agent' phrase for giving more clarity to key features section in clause 3 in README.md

feat/portkey-ai-docs-udpated (crewAIInc#2936)

66022f5

agent add knowledge sources fix and test (crewAIInc#2948)

6D4E
769909c

feat: load Tool from Agent repository by their own module (crewAIInc#…

f1ff07b

…2940) Previously, we only supported tools from the crewai-tools open-source repository. Now, we're introducing improved support for private tool repositories.

Minor adjustments on Tool publish and docs (crewAIInc#2958)

d7985b6

* fix: fix tool publisher logger when available_exports is found * docs: update docs and templates since we support Python 3.13

docs: Fix missing await keywords in async crew kickoff methods and ad…

0edd7b5

…d llm selection guide (crewAIInc#2959)

Add enterprise testing image (crewAIInc#2960)

eb16411

Update version to 0.126.0 and dependencies in pyproject.toml and lock…

c3ebef7

… files (crewAIInc#2961)

fix: remove duplicated message about Tool result (crewAIInc#2964)

e5cfb0b

We are currently inserting tool results into LLM messages twice, which may unnecessarily increase processing costs, especially for longer outputs.

docs: add minimum UV version required to use the Tool repository (cre…

ff4a7ad

…wAIInc#2965) * docs: add minimum UV version required to use the Tool repository * docs: remove memory from Agent docs The Agent does not support `memory` attribute

docs: update hallucination guardrail examples

e66fa58

- Add basic usage example showing guardrail uses task's expected_output as default context - Add explicit context example for custom reference content

Increasing the default X-axis spacing for flow plotting (crewAIInc#2967)

49fd85d

* Increasing the default X-axis spacing for flow plotting * removing unused imports

build: upgrade LiteLLM to support latest Openai version (crewAIInc#2963)

93b219b

Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com>

docs: improve docs about planning LLM usage (crewAIInc#2977)

b5ae72b

docs: fix the guide on persistence (crewAIInc#2849)

595f61e

Co-authored-by: Lucas Gomide <lucaslg200@gmail.com>

docs: update Python version requirement from <=3.13 to <3.14 (crewAII…

a950490

…nc#2987) This correctly reflects support for all 3.13.x patch version

LiteAgent w/ Guardrail (crewAIInc#2982)

a0b4374

* feat: add guardrail support for Agents when using direct kickoff calls * refactor: expose guardrail func in a proper utils file * fix: resolve Self import on python 3.10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fixing various typos in /docs #2855

Fixing various typos in /docs #2855

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fixing various typos in /docs #2855

Are you sure you want to change the base?

Fixing various typos in /docs #2855

Uh oh!

Conversation

Uh oh!

Code Review Comment for PR #2855 - Documentation Typo Fixes

Overview

File Analysis and Suggested Improvements

1. README.md

2. docs/concepts/knowledge.mdx

3. docs/concepts/llms.mdx

4. docs/concepts/memory.mdx

5. docs/examples/example.mdx

6. docs/how-to/arize-phoenix-observability.mdx

7. docs/how-to/opik-observability.mdx

General Recommendations

Conclusion

Action Items

Uh oh!

Uh oh!

Uh oh!