Tony Kipkemboi
dfc4255f2f
docs: Add transparency features for prompts and memory systems ( #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
2025-05-27 10:08:40 -07:00
Tony Kipkemboi
2460f61d3e
docs: major docs updates ( #2897 )
2025-05-23 16:04:37 -04:00
Tony Kipkemboi
0b35e40a24
docs: add StagehandTool documentation and improve MDX structure ( #2842 )
Notify Downstream / notify-downstream (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled
2025-05-15 12:24:25 -04:00
omahs
e23bc2aaa7
Fix typos ( #2774 )
...
* fix typos
* fix typo
* fix typos
---------
Co-authored-by: Tony Kipkemboi <iamtonykipkemboi@gmail.com >
2025-05-07 11:11:57 -04:00
Tony Kipkemboi
cac06adc6c
docs: update docxsearchtool.mdx ( #2767 )
...
Notify Downstream / notify-downstream (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled
- add `docx2txt` as a dependency requirement for the tool
2025-05-06 17:14:05 -04:00
Vidit Ostwal
c3726092fd
Added Advance Configuration Docs for Rag Tool ( #2713 )
...
* Added Advance Configuration Docs for Rag Tool
* Re-run test cases
* Change doc
* prepping new version (#2733 )
---------
Co-authored-by: Lucas Gomide <lucaslg200@gmail.com >
Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com >
2025-05-06 09:07:52 -04:00
Lucas Gomide
9ebf3aa043
docs(CodeInterpreterTool): update docs ( #2675 )
2025-04-23 10:27:25 -07:00
Tony Kipkemboi
6d0039b117
docs: 0.114.0 release notes, navigation restructure, new guides, deploy video, and cleanup ( #2653 )
...
Notify Downstream / notify-downstream (push) Waiting to run
- Add v0.114.0 release notes with highlights image and doc links
- Restructure docs navigation (Strategy group, Releases tab, navbar links)
- Update quickstart with deployment video and clearer instructions
- Add/rename guides (Custom Manager Agent, Custom LLM)
- Remove legacy concept/tool docs
- Add new images and tool docs
- Minor formatting and content improvements throughout
2025-04-21 19:18:21 -04:00
Greyson LaLonde
8e555149f7
fix: docs import path for json search tool ( #2631 )
...
- updated import path to crewai-tools
- removed old comment
2025-04-17 07:51:20 -07:00
Cypher Pepe
0cd524af86
fixed broken link in docs/tools/weaviatevectorsearchtool.mdx ( #2569 )
2025-04-11 11:58:01 -04:00
Tony Kipkemboi
bdc92deade
docs: update changelog dates ( #2437 )
...
* docs: update changelog dates
* docs: add aws bedrock tools docs
* docs: fix incorrect respect_context_window parameter in Crew example
2025-03-24 12:06:50 -04:00
Lorenze Jay
2155acb3a3
docs: Update JSONSearchTool and RagTool configuration parameter from 'embedder' to 'embedding_model' ( #2311 )
...
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com >
2025-03-20 13:11:37 -04:00
Jakub Kopecký
24f1a19310
feat: add docs for ApifyActorsTool ( #2254 )
...
* add docs for ApifyActorsTool
* improve readme, add link to template
* format
* improve tool docs
* improve readme
* Update apifyactorstool.mdx (#1 )
* Update apifyactorstool.mdx
* Update apifyactorstool.mdx
* dans suggestions
* custom apify icon
* update descripton
* Update apifyactorstool.mdx
---------
Co-authored-by: Jan Čurn <jan.curn@gmail.com >
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com >
2025-03-16 12:29:57 -04:00
Tony Kipkemboi
60d13bf7e8
docs: Tool docs improvements ( #2259 )
...
* docs: add Qdrant vector search tool documentation
* Update installation docs to use uv and improve quickstart guide
* docs: improve installation instructions and add structured outputs video
* Update tool documentation with agent integration examples and consistent formatting
2025-03-03 10:29:37 -05:00
Tony Kipkemboi
86825e1769
docs: add Qdrant vector search tool documentation ( #2184 )
...
Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com >
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com >
2025-02-27 13:54:44 -05:00
devin-ai-integration[bot]
a79d77dfd7
docs: document FileWriterTool as solution for file writing issues ( #2039 )
...
* docs: add FileWriterTool recommendation for file writing issues
- Add FileWriterTool recommendation in _save_file docstring
- Update error message to suggest using FileWriterTool for cross-platform compatibility
- Resolves #2015
Co-Authored-By: Joe Moura <joao@crewai.com >
* docs: enhance FileWriterTool documentation
- Add cross-platform compatibility details
- Highlight UTF-8 encoding support
- Emphasize Windows compatibility
- Add recommendation for users experiencing file writing issues
Part of #2015
Co-Authored-By: Joe Moura <joao@crewai.com >
* refactor: improve _save_file type hints and error messages
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 >
2025-02-09 16:21:56 -03:00
Tony Kipkemboi
c642ebf97e
docs: improve formatting and clarity in CLI and Composio Tool docs ( #1946 )
...
* docs: improve formatting and clarity in CLI and Composio Tool docs
- Add Terminal label to shell code blocks in CLI docs
- Update Composio Tool title and fix tip formatting
* docs: improve installation guide with virtual environment details
- Update Python version requirements and commands
- Add detailed virtual environment setup instructions
- Clarify project-specific environment activation steps
- Streamline additional tools installation with UV
* docs: simplify installation guide
- Remove redundant virtual environment instructions
- Simplify project creation steps
- Update UV package manager description
2025-01-22 10:30:16 -05:00
Abhishek Patil
aba68da542
feat: add Composio docs ( #1904 )
...
* feat: update Composio tool docs
* Update composiotool.mdx
* fix: minor changes
---------
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com >
2025-01-21 11:03:37 -05:00
theCyberTech
58af5c08f9
docs: add gh_token documentation to GithubSearchTool
2024-11-20 19:23:09 +08:00
Rok Benko
67f55bae2c
Fix incorrect parameter name in Vision tool docs page ( #1461 )
...
Co-authored-by: João Moura <joaomdmoura@gmail.com >
2024-10-17 13:18:31 -03:00
Tony Kipkemboi
a7696d5aed
Migrate docs from MkDocs to Mintlify ( #1423 )
...
* add new mintlify docs
* add favicon.svg
* minor edits
* add github stats
2024-10-10 19:14:28 -03:00
William Espegren
17bffb0803
docs: add spider docs ( #1165 )
...
* docs: add spider docs
* chore: add "Spider scraper" to mkdocs.yml
2024-08-20 07:53:04 -03:00
Eduardo Chiarotti
97d7bfb52a
docs: Update Dalle, FileWrite, Nl2Sql and Side menu Tools ( #1175 )
...
* docs: Update Dalle, FileWrite, Nl2Sql and Side menu Tools
* docs: remove unused phrase
* docs: fix identation
2024-08-13 12:29:34 -03:00
Rafael Miller
9f85a2a011
Added Firecrawl tools to docs ( #628 )
2024-08-13 12:09:11 -03:00
João Moura
183f466ac4
adding new docs
2024-08-11 15:50:42 -03:00
João Moura
59ab1ef9f4
adding docs for new tools
2024-08-11 00:07:00 -03:00
Rip&Tear
09f92122d5
Docs minor fixes ( #1035 )
...
* Minor fixes and updates
* minor fixes across docs
---------
Co-authored-by: theCyberTech <mattrapidb@gmail.com >
2024-08-02 15:01:16 -03:00
Samuel Mallet
1697b4cacb
Add docs for new parameters to SerperDevTool ( #993 )
2024-07-28 15:09:55 -03:00
prime-computing-lab
68e9e54c88
Update MDXSearchTool.md ( #745 )
...
description fixed to markdown language instead of marketing search
2024-07-08 02:21:00 -03:00
Alex Brinsmead
a6ff342948
Fix incorrect definition of RAG in GithubTool docs ( #864 )
2024-07-06 01:31:51 -03:00
Taleb
d2eb54ebf8
Performed spell check across the entire documentation ( #872 )
...
Thank you once again!
2024-07-06 01:30:40 -03:00
Eduardo Chiarotti
c81146505a
docs: Update training feature/code interpreter docs ( #852 )
...
* docs: remove training docs from README
* docs: add CodeinterpreterTool to docs and update docs
* docs: fix name of tool
2024-07-02 13:00:37 -03:00
João Moura
508fbd49e9
preparing new version
2024-07-01 18:28:11 -07:00
Eduardo Chiarotti
6018fe5872
feat: add CodeInterpreterTool to run when enable code execution ( #804 )
...
* feat: add CodeInterpreterTool to run when enable code execution is allowed on agent
* feat: change to allow_code_execution
* feat: add readme for CodeInterpreterTool
2024-06-27 02:25:39 -03:00
Bruno Tanabe
9e61b8325b
fix: Fix grammar error in documentation in PDF Search Tool ( #819 )
...
Correction of grammar error in the CrewAI documentation, on the page 'https://docs.crewai.com/tools/PDFSearchTool/ ' it says 'Optinal' instead of 'Optional'.
2024-06-27 00:41:22 -03:00
João Moura
9f384e3fc1
Updating Docs
2024-06-20 02:19:35 -03:00
Mish Ushakov
56f1d24e9d
Update BrowserbaseLoadTool.md ( #647 )
2024-05-24 00:05:52 -03:00
João Moura
7fd8850ddb
Small RC Fixes ( #608 )
...
* mentioning ollama on the docs as embedder
* lowering barrier to match tool with simialr name
* Fixing agent tools to support co_worker
* Adding new tests
* Fixing type"
* updating tests
* fixing conflict
2024-05-13 02:29:04 -03:00
Alex Fazio
ff51a2da9b
corrected imprecision in the instantiation ( #555 )
2024-05-05 03:55:13 -03:00
Mish Ushakov
20a81af95f
Added Browserbase loader to the docs ( #508 )
...
* Create BrowserbaseLoadTool.md
* added browserbase loader
2024-05-02 03:15:59 -03:00
Alex Fazio
48f53b529b
fix to import statement PGSearchTool.md ( #548 )
...
fix to the import statement in PGSearchTool documentation
2024-05-02 03:10:43 -03:00
Alex Fazio
b862e464f8
docs fix to xml tool import statement ( #546 )
...
* docs fix to xml tool import statement
* Update XMLSearchTool.md
2024-05-01 12:53:49 -03:00
Kaushal Powar
afc616d263
Update GitHubSearchTool.md ( #357 )
...
GithubSearchTool was misspelled as GitHubSearchTool
Co-authored-by: João Moura <joaomdmoura@gmail.com >
2024-04-19 02:40:38 -03:00
Rueben Ramirez
b1daf17a61
whitespace consistency across docs ( #407 )
...
I saw a rendedered whitespace inconsistency in the Tasks docs here:
ed31860071/docs/core-concepts/Tasks.md (L173)rramirez@ruebens-mbp.tail7c016.ts.net >
Co-authored-by: João Moura <joaomdmoura@gmail.com >
2024-04-05 19:47:09 -03:00
João Moura
a7f007f475
Updating docs
2024-04-04 15:29:45 -03:00
Ken Jenney
a3abdb5d19
Update ScrapeWebsiteTool.md ( #385 )
2024-03-30 11:57:08 -03:00
chowderhead
e3ebeb9dde
Update GitHubSearchTool.md ( #390 )
...
Import statement has a lower case h
2024-03-30 11:56:34 -03:00
Gui Vieira
aa0eb02968
Custom model docs ( #368 )
2024-03-22 03:01:34 -03:00
João Moura
730b71fad8
update serper doc
2024-03-04 11:15:49 -03:00
João Moura
364cf216a0
updating docs disclaimer
2024-03-04 09:59:01 -03:00
