mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
93dafe2637
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
98 lines
3.8 KiB
Plaintext
98 lines
3.8 KiB
Plaintext
---
|
||
title: "Overview"
|
||
description: "Read, write, and search through various file formats with CrewAI's document processing tools"
|
||
icon: "face-smile"
|
||
mode: "wide"
|
||
---
|
||
|
||
These tools enable your agents to work with various file formats and document types. From reading PDFs to processing JSON data, these tools handle all your document processing needs.
|
||
|
||
## **Available Tools**
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="File Read Tool" icon="folders" href="/en/tools/file-document/filereadtool">
|
||
Read content from any file type including text, markdown, and more.
|
||
</Card>
|
||
|
||
<Card title="File Write Tool" icon="file-pen" href="/en/tools/file-document/filewritetool">
|
||
Write content to files, create new documents, and save processed data.
|
||
</Card>
|
||
|
||
<Card title="PDF Search Tool" icon="file-pdf" href="/en/tools/file-document/pdfsearchtool">
|
||
Search and extract text content from PDF documents efficiently.
|
||
</Card>
|
||
|
||
<Card title="DOCX Search Tool" icon="file-word" href="/en/tools/file-document/docxsearchtool">
|
||
Search through Microsoft Word documents and extract relevant content.
|
||
</Card>
|
||
|
||
<Card title="JSON Search Tool" icon="brackets-curly" href="/en/tools/file-document/jsonsearchtool">
|
||
Parse and search through JSON files with advanced query capabilities.
|
||
</Card>
|
||
|
||
<Card title="CSV Search Tool" icon="table" href="/en/tools/file-document/csvsearchtool">
|
||
Process and search through CSV files, extract specific rows and columns.
|
||
</Card>
|
||
|
||
<Card title="XML Search Tool" icon="code" href="/en/tools/file-document/xmlsearchtool">
|
||
Parse XML files and search for specific elements and attributes.
|
||
</Card>
|
||
|
||
<Card title="MDX Search Tool" icon="markdown" href="/en/tools/file-document/mdxsearchtool">
|
||
Search through MDX files and extract content from documentation.
|
||
</Card>
|
||
|
||
<Card title="TXT Search Tool" icon="file-lines" href="/en/tools/file-document/txtsearchtool">
|
||
Search through plain text files with pattern matching capabilities.
|
||
</Card>
|
||
|
||
<Card title="Directory Search Tool" icon="folder-open" href="/en/tools/file-document/directorysearchtool">
|
||
Search for files and folders within directory structures.
|
||
</Card>
|
||
|
||
<Card title="Directory Read Tool" icon="folder" href="/en/tools/file-document/directoryreadtool">
|
||
Read and list directory contents, file structures, and metadata.
|
||
</Card>
|
||
|
||
<Card title="OCR Tool" icon="image" href="/en/tools/file-document/ocrtool">
|
||
Extract text from images (local files or URLs) using a vision‑capable LLM.
|
||
</Card>
|
||
|
||
<Card title="PDF Text Writing Tool" icon="file-pdf" href="/en/tools/file-document/pdf-text-writing-tool">
|
||
Write text at specific coordinates in PDFs, with optional custom fonts.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
## **Common Use Cases**
|
||
|
||
- **Document Processing**: Extract and analyze content from various file formats
|
||
- **Data Import**: Read structured data from CSV, JSON, and XML files
|
||
- **Content Search**: Find specific information within large document collections
|
||
- **File Management**: Organize and manipulate files and directories
|
||
- **Data Export**: Save processed results to various file formats
|
||
|
||
## **Quick Start Example**
|
||
|
||
```python
|
||
from crewai_tools import FileReadTool, PDFSearchTool, JSONSearchTool
|
||
|
||
# Create tools
|
||
file_reader = FileReadTool()
|
||
pdf_searcher = PDFSearchTool()
|
||
json_processor = JSONSearchTool()
|
||
|
||
# Add to your agent
|
||
agent = Agent(
|
||
role="Document Analyst",
|
||
tools=[file_reader, pdf_searcher, json_processor],
|
||
goal="Process and analyze various document types"
|
||
)
|
||
```
|
||
|
||
## **Tips for Document Processing**
|
||
|
||
- **File Permissions**: Ensure your agent has proper read/write permissions
|
||
- **Large Files**: Consider chunking for very large documents
|
||
- **Format Support**: Check tool documentation for supported file formats
|
||
- **Error Handling**: Implement proper error handling for corrupted or inaccessible files
|