Can you please add a new Community Topic called Documentation enhancements

There are many areas where the documentation could be improved, but much of the useful feedback is currently buried in user posts.

While the existing documentation is valuable, it would benefit from refinement and a dedicated community space to focus on improving and iterating on it.

Suggestions for Improvement:

  1. Tested Code: Ensure examples are tested on “approved” or multiple environments to confirm functionality.
  2. Functional Examples: Provide code that works reliably out of the box.
  3. Practical Details: Include critical information, such as file paths, common dependency issues for base crewai and documented tools like Docling, readiness checks for code maybe ‘crewai check dependancies’.
  4. Real-World Scenarios: Add clear, practical examples, such as:
  • Using Docling with multiple files.
  • Guidance on where to place code—e.g., in main or crews .
  • Guidance on solving common content reading issues.
  1. Enhanced Examples: Expand on commands like crewai create crew to show:
  • Adding Docling.
  • Setting up PDF knowledge search.
  • Examples that can serve as working templates.
  1. Tool-Specific Tips: Highlight specific behaviours, such as how Docling handles file names (e.g., issues with spaces in file names).

Areas for Review:

  • The Knowledge Concepts section:
    • Some parts work well.
    • Others, like Docling, have concepts that need addressing.

note: Have you guessed i have been fighting with Docling :wink:

2 Likes