mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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>
183 lines
6.2 KiB
Plaintext
183 lines
6.2 KiB
Plaintext
---
|
|
title: "تفعيل Crew Studio"
|
|
description: "تفعيل Crew Studio على CrewAI AMP"
|
|
icon: "comments"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Tip>
|
|
Crew Studio هو أداة قوية **بدون كود/منخفضة الكود** تتيح لك بسرعة
|
|
بناء أو هيكلة الطواقم عبر واجهة محادثة.
|
|
</Tip>
|
|
|
|
## ما هو Crew Studio؟
|
|
|
|
Crew Studio هو طريقة مبتكرة لإنشاء طواقم وكلاء الذكاء الاصطناعي بدون كتابة كود.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
مع Crew Studio، يمكنك:
|
|
|
|
- الدردشة مع مساعد الطاقم لوصف مشكلتك
|
|
- إنشاء الوكلاء والمهام تلقائياً
|
|
- اختيار الأدوات المناسبة
|
|
- تهيئة المدخلات الضرورية
|
|
- إنشاء كود قابل للتنزيل للتخصيص
|
|
- النشر مباشرة على منصة CrewAI AMP
|
|
|
|
## خطوات التهيئة
|
|
|
|
قبل البدء باستخدام Crew Studio، تحتاج لتهيئة اتصالات LLM:
|
|
|
|
<Steps>
|
|
<Step title="إعداد اتصال LLM">
|
|
انتقل إلى علامة تبويب **LLM Connections** في لوحة تحكم CrewAI AMP وأنشئ اتصال LLM جديداً.
|
|
|
|
<Note>
|
|
يمكنك استخدام أي مزود LLM تريده ويدعمه CrewAI.
|
|
</Note>
|
|
|
|
هيّئ اتصال LLM:
|
|
|
|
- أدخل `Connection Name` (مثل `OpenAI`)
|
|
- اختر مزود النموذج: `openai` أو `azure`
|
|
- اختر النماذج التي تريد استخدامها في طواقم Studio
|
|
- نوصي بـ `gpt-4o` و`o1-mini` و`gpt-4o-mini` على الأقل
|
|
- أضف مفتاح API كمتغير بيئة:
|
|
- لـ OpenAI: أضف `OPENAI_API_KEY` مع مفتاح API
|
|
- لـ Azure OpenAI: راجع [هذه المقالة](https://blog.crewai.com/configuring-azure-openai-with-crewai-a-comprehensive-guide/) لتفاصيل التهيئة
|
|
- انقر على `Add Connection` لحفظ التهيئة
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="التحقق من إضافة الاتصال">
|
|
بمجرد إتمام الإعداد، سترى الاتصال الجديد مُضافاً إلى قائمة الاتصالات المتاحة.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="تهيئة إعدادات LLM الافتراضية">
|
|
في القائمة الرئيسية، انتقل إلى **Settings → Defaults** وهيّئ إعدادات LLM الافتراضية:
|
|
|
|
- اختر النماذج الافتراضية للوكلاء والمكونات الأخرى
|
|
- عيّن التهيئات الافتراضية لـ Crew Studio
|
|
|
|
انقر على `Save Settings` لتطبيق تغييراتك.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## استخدام Crew Studio
|
|
|
|
الآن بعد تهيئة اتصال LLM والإعدادات الافتراضية، أنت جاهز لبدء استخدام Crew Studio!
|
|
|
|
<Steps>
|
|
<Step title="الوصول إلى Studio">
|
|
انتقل إلى قسم **Studio** في لوحة تحكم CrewAI AMP.
|
|
</Step>
|
|
|
|
<Step title="بدء محادثة">
|
|
ابدأ محادثة مع مساعد الطاقم بوصف المشكلة التي تريد حلها:
|
|
|
|
```md
|
|
I need a crew that can research the latest AI developments and create a summary report.
|
|
```
|
|
|
|
سيطرح مساعد الطاقم أسئلة توضيحية لفهم متطلباتك بشكل أفضل.
|
|
|
|
</Step>
|
|
|
|
<Step title="مراجعة الطاقم المُنشأ">
|
|
راجع تهيئة الطاقم المُنشأ، بما في ذلك:
|
|
|
|
- الوكلاء وأدوارهم
|
|
- المهام المطلوب تنفيذها
|
|
- المدخلات المطلوبة
|
|
- الأدوات المستخدمة
|
|
|
|
هذه فرصتك لتنقيح التهيئة قبل المتابعة.
|
|
|
|
</Step>
|
|
|
|
<Step title="النشر أو التنزيل">
|
|
بمجرد رضاك عن التهيئة، يمكنك:
|
|
|
|
- تنزيل الكود المُنشأ للتخصيص المحلي
|
|
- نشر الطاقم مباشرة على منصة CrewAI AMP
|
|
- تعديل التهيئة وإعادة إنشاء الطاقم
|
|
|
|
</Step>
|
|
|
|
<Step title="اختبار طاقمك">
|
|
بعد النشر، اختبر طاقمك بمدخلات نموذجية للتأكد من أنه يعمل كما هو متوقع.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Tip>
|
|
للحصول على أفضل النتائج، قدم أوصافاً واضحة ومفصلة لما تريد أن
|
|
يحققه طاقمك. ضمّن مدخلات ومخرجات محددة متوقعة في
|
|
وصفك.
|
|
</Tip>
|
|
|
|
## مثال على سير العمل
|
|
|
|
إليك سير عمل نموذجي لإنشاء طاقم مع Crew Studio:
|
|
|
|
<Steps>
|
|
<Step title="وصف مشكلتك">
|
|
ابدأ بوصف مشكلتك:
|
|
|
|
```md
|
|
I need a crew that can analyze financial news and provide investment recommendations
|
|
```
|
|
|
|
</Step>
|
|
|
|
{" "}
|
|
<Step title="الإجابة على الأسئلة">
|
|
أجب على أسئلة التوضيح من مساعد الطاقم لتنقيح
|
|
متطلباتك.
|
|
</Step>
|
|
|
|
<Step title="مراجعة الخطة">
|
|
راجع خطة الطاقم المُنشأة، التي قد تتضمن:
|
|
|
|
- وكيل بحث لجمع الأخبار المالية
|
|
- وكيل تحليل لتفسير البيانات
|
|
- وكيل توصيات لتقديم نصائح استثمارية
|
|
|
|
</Step>
|
|
|
|
{" "}
|
|
<Step title="الموافقة أو التعديل">
|
|
وافق على الخطة أو اطلب تغييرات إذا لزم الأمر.
|
|
</Step>
|
|
|
|
{" "}
|
|
<Step title="التنزيل أو النشر">
|
|
نزّل الكود للتخصيص أو انشر مباشرة على المنصة.
|
|
</Step>
|
|
|
|
<Step title="الاختبار والتنقيح">
|
|
اختبر طاقمك بمدخلات نموذجية ونقّح حسب الحاجة.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للمساعدة في Crew Studio أو أي ميزات أخرى في CrewAI
|
|
AMP.
|
|
</Card>
|