mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 05:08:12 +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>
54 lines
2.6 KiB
Plaintext
54 lines
2.6 KiB
Plaintext
---
|
|
title: 디렉터리 읽기
|
|
description: DirectoryReadTool은 디렉터리의 내용을 포괄적으로 나열할 수 있도록 설계된 강력한 유틸리티입니다.
|
|
icon: folder-tree
|
|
mode: "wide"
|
|
---
|
|
|
|
# `DirectoryReadTool`
|
|
|
|
<Note>
|
|
저희는 아직 도구를 개선하는 중이므로, 예기치 않은 동작이나 변경 사항이 있을 수 있습니다.
|
|
</Note>
|
|
|
|
## 설명
|
|
|
|
DirectoryReadTool은 디렉터리 내용을 포괄적으로 나열해주는 강력한 유틸리티입니다.
|
|
지정된 디렉터리를 재귀적으로 탐색할 수 있으며, 하위 디렉터리를 포함한 모든 파일을 상세하게 나열해 사용자에게 제공합니다.
|
|
이 도구는 디렉터리 구조에 대한 철저한 인벤토리가 필요하거나, 디렉터리 내 파일의 구성이 올바른지 검증할 때 매우 중요합니다.
|
|
|
|
## 설치
|
|
|
|
프로젝트에서 DirectoryReadTool을 사용하려면 `crewai_tools` 패키지를 설치해야 합니다. 이 패키지가 아직 환경에 없다면 아래 명령어를 사용하여 pip로 설치할 수 있습니다:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
이 명령어는 `crewai_tools` 패키지의 최신 버전을 설치하며, DirectoryReadTool을 비롯한 다양한 유틸리티를 사용할 수 있습니다.
|
|
|
|
## 예시
|
|
|
|
DirectoryReadTool을 사용하는 것은 간단합니다. 다음 코드 스니펫은 지정한 디렉터리의 내용을 나열하기 위해 이 도구를 설정하고 사용하는 방법을 보여줍니다:
|
|
|
|
```python Code
|
|
from crewai_tools import DirectoryReadTool
|
|
|
|
# 에이전트가 실행 중에 알게 되는 모든 디렉터리의 내용을 읽을 수 있도록 도구를 초기화합니다.
|
|
tool = DirectoryReadTool()
|
|
|
|
# 또는
|
|
|
|
# 특정 디렉터리로 도구를 초기화하여,
|
|
# 에이전트가 지정한 디렉터리의 내용만 읽을 수 있도록 합니다.
|
|
tool = DirectoryReadTool(directory='/path/to/your/directory')
|
|
```
|
|
|
|
## 인수
|
|
|
|
다음 매개변수들은 `DirectoryReadTool`의 동작을 사용자 정의하는 데 사용할 수 있습니다:
|
|
|
|
| 인수 | 타입 | 설명 |
|
|
|:---------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **directory** | `string` | _선택 사항_. 나열하려는 디렉터리의 경로를 지정하는 인수입니다. 절대 경로와 상대 경로 모두 허용하며, 원하는 디렉터리로 도구를 안내하여 내용을 나열할 수 있습니다. |
|