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>
85 lines
3.6 KiB
Plaintext
85 lines
3.6 KiB
Plaintext
---
|
||
title: البحث في توثيق الكود باستخدام RAG
|
||
description: أداة `CodeDocsSearchTool` هي أداة RAG (التوليد المعزز بالاسترجاع) قوية مصممة للبحث الدلالي داخل توثيق الكود.
|
||
icon: code
|
||
mode: "wide"
|
||
---
|
||
|
||
# `CodeDocsSearchTool`
|
||
|
||
<Note>
|
||
**تجريبي**: لا نزال نعمل على تحسين الأدوات، لذا قد يحدث سلوك غير متوقع أو تغييرات في المستقبل.
|
||
</Note>
|
||
|
||
## الوصف
|
||
|
||
أداة CodeDocsSearchTool هي أداة RAG (التوليد المعزز بالاسترجاع) قوية مصممة للبحث الدلالي داخل توثيق الكود.
|
||
تتيح للمستخدمين العثور بكفاءة على معلومات أو مواضيع محددة داخل توثيق الكود. من خلال تقديم `docs_url` أثناء التهيئة،
|
||
تقتصر الأداة على البحث في موقع التوثيق المحدد. بدلاً من ذلك، بدون `docs_url` محدد،
|
||
تبحث الأداة عبر مجموعة واسعة من توثيق الكود المعروف أو المكتشف خلال تنفيذها، مما يجعلها متعددة الاستخدامات لاحتياجات البحث المختلفة في التوثيق.
|
||
|
||
## التثبيت
|
||
|
||
للبدء في استخدام CodeDocsSearchTool، قم أولاً بتثبيت حزمة crewai_tools عبر pip:
|
||
|
||
```shell
|
||
pip install 'crewai[tools]'
|
||
```
|
||
|
||
## مثال
|
||
|
||
استخدم CodeDocsSearchTool كما يلي لإجراء عمليات بحث داخل توثيق الكود:
|
||
|
||
```python Code
|
||
from crewai_tools import CodeDocsSearchTool
|
||
|
||
# To search any code documentation content
|
||
# if the URL is known or discovered during its execution:
|
||
tool = CodeDocsSearchTool()
|
||
|
||
# OR
|
||
|
||
# To specifically focus your search on a given documentation site
|
||
# by providing its URL:
|
||
tool = CodeDocsSearchTool(docs_url='https://docs.example.com/reference')
|
||
```
|
||
<Note>
|
||
استبدل 'https://docs.example.com/reference' بعنوان URL الخاص بالتوثيق المستهدف
|
||
و 'How to use search tool' باستعلام البحث المناسب لاحتياجاتك.
|
||
</Note>
|
||
|
||
## المعاملات
|
||
|
||
يمكن استخدام المعاملات التالية لتخصيص سلوك `CodeDocsSearchTool`:
|
||
|
||
| المعامل | النوع | الوصف |
|
||
|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------|
|
||
| **docs_url** | `string` | _اختياري_. يحدد عنوان URL لتوثيق الكود المراد البحث فيه. |
|
||
|
||
## النموذج المخصص والتضمينات
|
||
|
||
بشكل افتراضي، تستخدم الأداة OpenAI لكل من التضمينات والتلخيص. لتخصيص النموذج، يمكنك استخدام قاموس تكوين كما يلي:
|
||
|
||
```python Code
|
||
tool = CodeDocsSearchTool(
|
||
config=dict(
|
||
llm=dict(
|
||
provider="ollama", # or google, openai, anthropic, llama2, ...
|
||
config=dict(
|
||
model="llama2",
|
||
# temperature=0.5,
|
||
# top_p=1,
|
||
# stream=true,
|
||
),
|
||
),
|
||
embedder=dict(
|
||
provider="google-generativeai", # or openai, ollama, ...
|
||
config=dict(
|
||
model_name="gemini-embedding-001",
|
||
task_type="RETRIEVAL_DOCUMENT",
|
||
# title="Embeddings",
|
||
),
|
||
),
|
||
)
|
||
)
|
||
``` |