andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2025-12-16 04:18:35 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: major docs updates (#2897)

Browse Source
This commit is contained in:
Tony Kipkemboi
2025-05-23 16:04:37 -04:00
committed by GitHub
parent be24559630
commit 2460f61d3e
111 changed files with 2952 additions and 1362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
docs/docs.json
View File

@@ -7,7 +7,7 @@
"light": "#F3A78B",
"dark": "#C94C3C"
},
"favicon": "favicon.svg",
"favicon": "images/favicon.svg",
"contextual": {
"options": ["copy", "view", "chatgpt", "claude"]
},
@@ -82,70 +82,113 @@
"concepts/event-listener"
]
},
{
"group": "Tools",
"pages": [
"tools/aimindtool",
"tools/apifyactorstool",
"tools/bedrockinvokeagenttool",
"tools/bedrockkbretriever",
"tools/bravesearchtool",
"tools/browserbaseloadtool",
"tools/codedocssearchtool",
"tools/codeinterpretertool",
"tools/composiotool",
"tools/csvsearchtool",
"tools/dalletool",
"tools/directorysearchtool",
"tools/directoryreadtool",
"tools/docxsearchtool",
"tools/exasearchtool",
"tools/filereadtool",
"tools/filewritetool",
"tools/firecrawlcrawlwebsitetool",
"tools/firecrawlscrapewebsitetool",
"tools/firecrawlsearchtool",
"tools/githubsearchtool",
"tools/hyperbrowserloadtool",
"tools/linkupsearchtool",
"tools/llamaindextool",
"tools/langchaintool",
"tools/serperdevtool",
"tools/s3readertool",
"tools/s3writertool",
"tools/scrapegraphscrapetool",
"tools/scrapeelementfromwebsitetool",
"tools/jsonsearchtool",
"tools/mdxsearchtool",
"tools/mysqltool",
"tools/multiontool",
"tools/nl2sqltool",
"tools/patronustools",
"tools/pdfsearchtool",
"tools/pgsearchtool",
"tools/qdrantvectorsearchtool",
"tools/ragtool",
"tools/scrapewebsitetool",
"tools/scrapflyscrapetool",
"tools/seleniumscrapingtool",
"tools/snowflakesearchtool",
"tools/spidertool",
"tools/stagehandtool",
"tools/txtsearchtool",
"tools/visiontool",
"tools/weaviatevectorsearchtool",
"tools/websitesearchtool",
"tools/xmlsearchtool",
"tools/youtubechannelsearchtool",
"tools/youtubevideosearchtool"
]
},
{
"group": "MCP Integration",
"pages": [
"mcp/crewai-mcp-integration"
]
},
{
"group": "Tools",
"pages": [
"tools/overview",
{
"group": "File & Document",
"pages": [
"tools/file-document/overview",
"tools/file-document/filereadtool",
"tools/file-document/filewritetool",
"tools/file-document/pdfsearchtool",
"tools/file-document/docxsearchtool",
"tools/file-document/mdxsearchtool",
"tools/file-document/xmlsearchtool",
"tools/file-document/txtsearchtool",
"tools/file-document/jsonsearchtool",
"tools/file-document/csvsearchtool",
"tools/file-document/directorysearchtool",
"tools/file-document/directoryreadtool"
]
},
{
"group": "Web Scraping & Browsing",
"pages": [
"tools/web-scraping/overview",
"tools/web-scraping/scrapewebsitetool",
"tools/web-scraping/scrapeelementfromwebsitetool",
"tools/web-scraping/scrapflyscrapetool",
"tools/web-scraping/seleniumscrapingtool",
"tools/web-scraping/scrapegraphscrapetool",
"tools/web-scraping/spidertool",
"tools/web-scraping/browserbaseloadtool",
"tools/web-scraping/hyperbrowserloadtool",
"tools/web-scraping/stagehandtool",
"tools/web-scraping/firecrawlcrawlwebsitetool",
"tools/web-scraping/firecrawlscrapewebsitetool",
"tools/web-scraping/firecrawlsearchtool"
]
},
{
"group": "Search & Research",
"pages": [
"tools/search-research/overview",
"tools/search-research/serperdevtool",
"tools/search-research/bravesearchtool",
"tools/search-research/exasearchtool",
"tools/search-research/linkupsearchtool",
"tools/search-research/githubsearchtool",
"tools/search-research/websitesearchtool",
"tools/search-research/codedocssearchtool",
"tools/search-research/youtubechannelsearchtool",
"tools/search-research/youtubevideosearchtool"
]
},
{
"group": "Database & Data",
"pages": [
"tools/database-data/overview",
"tools/database-data/mysqltool",
"tools/database-data/pgsearchtool",
"tools/database-data/snowflakesearchtool",
"tools/database-data/nl2sqltool",
"tools/database-data/qdrantvectorsearchtool",
"tools/database-data/weaviatevectorsearchtool"
]
},
{
"group": "AI & Machine Learning",
"pages": [
"tools/ai-ml/overview",
"tools/ai-ml/dalletool",
"tools/ai-ml/visiontool",
"tools/ai-ml/aimindtool",
"tools/ai-ml/llamaindextool",
"tools/ai-ml/langchaintool",
"tools/ai-ml/ragtool",
"tools/ai-ml/codeinterpretertool",
"tools/ai-ml/patronustools"
]
},
{
"group": "Cloud & Storage",
"pages": [
"tools/cloud-storage/overview",
"tools/cloud-storage/s3readertool",
"tools/cloud-storage/s3writertool",
"tools/cloud-storage/bedrockinvokeagenttool",
"tools/cloud-storage/bedrockkbretriever"
]
},
{
"group": "Automation & Integration",
"pages": [
"tools/automation/overview",
"tools/automation/apifyactorstool",
"tools/automation/composiotool",
"tools/automation/multiontool"
]
}
]
},
{
"group": "Agent Monitoring & Observability",
"pages": [
@@ -169,15 +212,18 @@
"how-to/custom-llm",
"how-to/custom-manager-agent",
"how-to/customizing-agents",
"how-to/dalle-image-generation",
"how-to/force-tool-output-as-result",
"how-to/hierarchical-process",
"how-to/human-in-the-loop",
"how-to/human-input-on-execution",
"how-to/kickoff-async",
"how-to/kickoff-for-each",
"how-to/llm-connections",
"how-to/multimodal-agents",
"how-to/replay-tasks-from-latest-crew-kickoff",
"how-to/sequential-process"
"how-to/sequential-process",
"how-to/using-annotations"
]
},
{
@@ -197,17 +243,6 @@
"enterprise/introduction"
]
},
{
"group": "How-To Guides",
"pages": [
"enterprise/guides/build-crew",
"enterprise/guides/deploy-crew",
"enterprise/guides/kickoff-crew",
"enterprise/guides/update-crew",
"enterprise/guides/use-crew-api",
"enterprise/guides/enable-crew-studio"
]
},
{
"group": "Features",
"pages": [
@@ -217,6 +252,24 @@
"enterprise/features/hallucination-guardrail"
]
},
{
"group": "How-To Guides",
"pages": [
"enterprise/guides/build-crew",
"enterprise/guides/deploy-crew",
"enterprise/guides/kickoff-crew",
"enterprise/guides/update-crew",
"enterprise/guides/enable-crew-studio",
"enterprise/guides/azure-openai-setup",
"enterprise/guides/hubspot-trigger",
"enterprise/guides/react-component-export",
"enterprise/guides/salesforce-trigger",
"enterprise/guides/slack-trigger",
"enterprise/guides/team-management",
"enterprise/guides/webhook-automation",
"enterprise/guides/zapier-trigger"
]
},
{
"group": "Resources",
"pages": [
@@ -225,6 +278,21 @@
}
]
},
{
"tab": "API Reference",
"groups": [
{
"group": "Getting Started",
"pages": [
"api-reference/introduction"
]
},
{
"group": "Endpoints",
"openapi": "enterprise-api.yaml"
}
]
},
{
"tab": "Examples",
"groups": [
@@ -260,6 +328,11 @@
"href": "https://community.crewai.com",
"icon": "discourse"
},
{
"anchor": "Crew GPT",
"href": "https://chatgpt.com/g/g-qqTuUWsBY-crewai-assistant",
"icon": "robot"
},
{
"anchor": "Get Help",
"href": "mailto:support@crewai.com",
@@ -269,8 +342,8 @@
}
},
"logo": {
"light": "crew_only_logo.png",
"dark": "crew_only_logo.png"
"light": "images/crew_only_logo.png",
"dark": "images/crew_only_logo.png"
},
"appearance": {
"default": "dark",
@@ -291,6 +364,16 @@
"search": {
"prompt": "Search CrewAI docs"
},
"api": {
"baseUrl": "https://your-actual-crew-name.crewai.com",
"auth": {
"method": "bearer",
"name": "Authorization"
},
"playground": {
"mode": "simple"
}
},
"seo": {
"indexing": "all"
},