mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18: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
5.0 KiB
Plaintext
98 lines
5.0 KiB
Plaintext
---
|
|
title: "نظرة عامة"
|
|
description: "قراءة وكتابة والبحث في صيغ ملفات متنوعة باستخدام أدوات معالجة المستندات من CrewAI"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
تتيح هذه الأدوات لوكلائك العمل مع صيغ ملفات وأنواع مستندات متنوعة. من قراءة ملفات PDF إلى معالجة بيانات JSON، تتعامل هذه الأدوات مع جميع احتياجات معالجة المستندات الخاصة بك.
|
|
|
|
## **الأدوات المتاحة**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="أداة قراءة الملفات" icon="folders" href="/ar/tools/file-document/filereadtool">
|
|
قراءة المحتوى من أي نوع ملف بما في ذلك النصوص و Markdown والمزيد.
|
|
</Card>
|
|
|
|
<Card title="أداة كتابة الملفات" icon="file-pen" href="/ar/tools/file-document/filewritetool">
|
|
كتابة المحتوى في الملفات وإنشاء مستندات جديدة وحفظ البيانات المعالجة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث PDF" icon="file-pdf" href="/ar/tools/file-document/pdfsearchtool">
|
|
البحث واستخراج محتوى نصي من مستندات PDF بكفاءة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث DOCX" icon="file-word" href="/ar/tools/file-document/docxsearchtool">
|
|
البحث في مستندات Microsoft Word واستخراج المحتوى ذي الصلة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث JSON" icon="brackets-curly" href="/ar/tools/file-document/jsonsearchtool">
|
|
تحليل والبحث في ملفات JSON بإمكانيات استعلام متقدمة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث CSV" icon="table" href="/ar/tools/file-document/csvsearchtool">
|
|
معالجة والبحث في ملفات CSV واستخراج صفوف وأعمدة محددة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث XML" icon="code" href="/ar/tools/file-document/xmlsearchtool">
|
|
تحليل ملفات XML والبحث عن عناصر وخصائص محددة.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث MDX" icon="markdown" href="/ar/tools/file-document/mdxsearchtool">
|
|
البحث في ملفات MDX واستخراج المحتوى من الوثائق.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث TXT" icon="file-lines" href="/ar/tools/file-document/txtsearchtool">
|
|
البحث في ملفات النص العادي بإمكانيات مطابقة الأنماط.
|
|
</Card>
|
|
|
|
<Card title="أداة بحث المجلدات" icon="folder-open" href="/ar/tools/file-document/directorysearchtool">
|
|
البحث عن الملفات والمجلدات داخل هياكل المجلدات.
|
|
</Card>
|
|
|
|
<Card title="أداة قراءة المجلدات" icon="folder" href="/ar/tools/file-document/directoryreadtool">
|
|
قراءة وعرض محتويات المجلدات وهياكل الملفات والبيانات الوصفية.
|
|
</Card>
|
|
|
|
<Card title="أداة OCR" icon="image" href="/ar/tools/file-document/ocrtool">
|
|
استخراج النص من الصور (ملفات محلية أو عناوين URL) باستخدام نموذج LLM مزود بالرؤية.
|
|
</Card>
|
|
|
|
<Card title="أداة كتابة نص PDF" icon="file-pdf" href="/ar/tools/file-document/pdf-text-writing-tool">
|
|
كتابة نص في إحداثيات محددة في ملفات PDF، مع خطوط مخصصة اختيارية.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## **حالات الاستخدام الشائعة**
|
|
|
|
- **معالجة المستندات**: استخراج وتحليل المحتوى من صيغ ملفات متنوعة
|
|
- **استيراد البيانات**: قراءة بيانات منظمة من ملفات CSV و JSON و XML
|
|
- **بحث المحتوى**: العثور على معلومات محددة داخل مجموعات مستندات كبيرة
|
|
- **إدارة الملفات**: تنظيم ومعالجة الملفات والمجلدات
|
|
- **تصدير البيانات**: حفظ النتائج المعالجة في صيغ ملفات متنوعة
|
|
|
|
## **مثال للبدء السريع**
|
|
|
|
```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"
|
|
)
|
|
```
|
|
|
|
## **نصائح لمعالجة المستندات**
|
|
|
|
- **صلاحيات الملفات**: تأكد من أن وكيلك لديه صلاحيات القراءة/الكتابة المناسبة
|
|
- **الملفات الكبيرة**: فكر في التقسيم إلى أجزاء للمستندات الكبيرة جداً
|
|
- **دعم الصيغ**: راجع وثائق الأداة لمعرفة صيغ الملفات المدعومة
|
|
- **معالجة الأخطاء**: طبّق معالجة أخطاء مناسبة للملفات التالفة أو التي يتعذر الوصول إليها
|