mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel 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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
135 lines
4.6 KiB
Plaintext
135 lines
4.6 KiB
Plaintext
---
|
|
title: تكامل Neatlogs
|
|
description: افهم وأصلح وشارك عمليات تشغيل وكلاء CrewAI الخاصة بك
|
|
icon: magnifying-glass-chart
|
|
mode: "wide"
|
|
---
|
|
|
|
# مقدمة
|
|
|
|
يساعدك Neatlogs على **رؤية ما فعله وكيلك**، و**لماذا**، و**مشاركته**.
|
|
|
|
يلتقط كل خطوة: الأفكار، واستدعاءات الأدوات، والاستجابات، والتقييمات. لا سجلات خام. فقط تتبعات واضحة ومنظمة. ممتاز لتصحيح الأخطاء والتعاون.
|
|
|
|
## لماذا تستخدم Neatlogs؟
|
|
|
|
يستخدم وكلاء CrewAI أدوات متعددة وخطوات تفكير. عندما يحدث خطأ ما، تحتاج إلى السياق - وليس فقط الأخطاء.
|
|
|
|
يتيح لك Neatlogs:
|
|
|
|
- تتبع مسار اتخاذ القرار بالكامل
|
|
- إضافة ملاحظات مباشرة على الخطوات
|
|
- الدردشة مع التتبع باستخدام مساعد الذكاء الاصطناعي
|
|
- مشاركة عمليات التشغيل علنياً للحصول على ملاحظات
|
|
- تحويل الرؤى إلى مهام
|
|
|
|
كل ذلك في مكان واحد.
|
|
|
|
إدارة تتبعاتك بسهولة
|
|
|
|
|
|
|
|
|
|
أفضل تجربة مستخدم لعرض تتبع CrewAI. انشر التعليقات أينما تريد. استخدم الذكاء الاصطناعي لتصحيح الأخطاء.
|
|
|
|
|
|
|
|
|
|
|
|
## الميزات الأساسية
|
|
|
|
- **عارض التتبع**: تتبع الأفكار والأدوات والقرارات بالتسلسل
|
|
- **التعليقات المضمنة**: أشر إلى زملاء الفريق على أي خطوة تتبع
|
|
- **الملاحظات والتقييم**: حدد المخرجات كصحيحة أو غير صحيحة
|
|
- **إبراز الأخطاء**: وسم تلقائي لأخطاء API/الأدوات
|
|
- **تحويل المهام**: حوّل التعليقات إلى مهام موكلة
|
|
- **اسأل التتبع (AI)**: تحدث مع تتبعك باستخدام روبوت Neatlogs الذكي
|
|
- **المشاركة العامة**: انشر روابط التتبع لمجتمعك
|
|
|
|
## إعداد سريع مع CrewAI
|
|
|
|
<Steps>
|
|
<Step title="التسجيل والحصول على مفتاح API">
|
|
قم بزيارة [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs)، وأنشئ مشروعاً، وانسخ مفتاح API.
|
|
</Step>
|
|
<Step title="تثبيت SDK">
|
|
```bash
|
|
pip install neatlogs
|
|
```
|
|
(أحدث إصدار 0.8.0، Python 3.8+؛ رخصة MIT)
|
|
</Step>
|
|
<Step title="تهيئة Neatlogs">
|
|
قبل بدء وكلاء Crew، أضف:
|
|
|
|
```python
|
|
import neatlogs
|
|
neatlogs.init("YOUR_PROJECT_API_KEY")
|
|
```
|
|
|
|
يعمل الوكلاء كالمعتاد. يلتقط Neatlogs كل شيء تلقائياً.
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
|
|
|
|
## تحت الغطاء
|
|
|
|
وفقاً لـ GitHub، فإن Neatlogs:
|
|
|
|
- يلتقط الأفكار واستدعاءات الأدوات والاستجابات والأخطاء وإحصائيات الرموز المميزة
|
|
- يدعم توليد المهام بالذكاء الاصطناعي وسير عمل التقييم المتين
|
|
|
|
كل ذلك بسطرين فقط من الكود.
|
|
|
|
|
|
|
|
## شاهده وهو يعمل
|
|
|
|
### عرض توضيحي كامل (4 دقائق)
|
|
|
|
<iframe
|
|
className="w-full aspect-video rounded-xl"
|
|
src="https://www.youtube.com/embed/8KDme9T2I7Q?si=b8oHteaBwFNs_Duk"
|
|
title="NeatLogs overview"
|
|
frameBorder="0"
|
|
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
|
allowFullScreen
|
|
></iframe>
|
|
|
|
### تكامل CrewAI (30 ثانية)
|
|
|
|
<iframe
|
|
className="w-full aspect-video rounded-xl"
|
|
src="https://www.loom.com/embed/9c78b552af43452bb3e4783cb8d91230?sid=e9d7d370-a91a-49b0-809e-2f375d9e801d"
|
|
title="Loom video player"
|
|
frameBorder="0"
|
|
allowFullScreen
|
|
></iframe>
|
|
|
|
|
|
|
|
## الروابط والدعم
|
|
|
|
- [وثائق Neatlogs](https://docs.neatlogs.com/)
|
|
- [لوحة التحكم ومفتاح API](https://app.neatlogs.com/)
|
|
- [تابعنا على Twitter](https://twitter.com/neatlogs)
|
|
- البريد الإلكتروني: hello@neatlogs.com
|
|
- [GitHub SDK](https://github.com/NeatLogs/neatlogs)
|
|
|
|
|
|
|
|
## الخلاصة
|
|
|
|
بمجرد:
|
|
|
|
```bash
|
|
pip install neatlogs
|
|
|
|
import neatlogs
|
|
neatlogs.init("YOUR_API_KEY")
|
|
|
|
You can now capture, understand, share, and act on your CrewAI agent runs in seconds.
|
|
No setup overhead. Full trace transparency. Full team collaboration.
|
|
```
|