mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-06 23:49:24 +00:00
* 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>
115 lines
4.1 KiB
Plaintext
115 lines
4.1 KiB
Plaintext
---
|
||
title: Skills
|
||
description: Pacotes de skills baseados em sistema de arquivos que injetam contexto nos prompts dos agentes.
|
||
icon: bolt
|
||
mode: "wide"
|
||
---
|
||
|
||
## Visão Geral
|
||
|
||
Skills são diretórios autocontidos que fornecem aos agentes instruções, referências e assets específicos de domínio. Cada skill é definida por um arquivo `SKILL.md` com frontmatter YAML e um corpo em markdown.
|
||
|
||
Skills usam **divulgação progressiva** — metadados são carregados primeiro, instruções completas apenas quando ativadas, e catálogos de recursos apenas quando necessário.
|
||
|
||
## Estrutura de Diretório
|
||
|
||
```
|
||
my-skill/
|
||
├── SKILL.md # Obrigatório — frontmatter + instruções
|
||
├── scripts/ # Opcional — scripts executáveis
|
||
├── references/ # Opcional — documentos de referência
|
||
└── assets/ # Opcional — arquivos estáticos (configs, dados)
|
||
```
|
||
|
||
O nome do diretório deve corresponder ao campo `name` no `SKILL.md`.
|
||
|
||
## Formato do SKILL.md
|
||
|
||
```markdown
|
||
---
|
||
name: my-skill
|
||
description: Descrição curta do que esta skill faz e quando usá-la.
|
||
license: Apache-2.0 # opcional
|
||
compatibility: crewai>=0.1.0 # opcional
|
||
metadata: # opcional
|
||
author: your-name
|
||
version: "1.0"
|
||
allowed-tools: web-search file-read # opcional, delimitado por espaços
|
||
---
|
||
|
||
Instruções para o agente vão aqui. Este corpo em markdown é injetado
|
||
no prompt do agente quando a skill é ativada.
|
||
```
|
||
|
||
### Campos do Frontmatter
|
||
|
||
| Campo | Obrigatório | Restrições |
|
||
| :-------------- | :---------- | :----------------------------------------------------------------------- |
|
||
| `name` | Sim | 1–64 chars. Alfanumérico minúsculo e hifens. Sem hifens iniciais/finais/consecutivos. Deve corresponder ao nome do diretório. |
|
||
| `description` | Sim | 1–1024 chars. Descreve o que a skill faz e quando usá-la. |
|
||
| `license` | Não | Nome da licença ou referência a um arquivo de licença incluído. |
|
||
| `compatibility` | Não | Máx 500 chars. Requisitos de ambiente (produtos, pacotes, rede). |
|
||
| `metadata` | Não | Mapeamento arbitrário de chave-valor string. |
|
||
| `allowed-tools` | Não | Lista de ferramentas pré-aprovadas delimitada por espaços. Experimental. |
|
||
|
||
## Uso
|
||
|
||
### Skills no Nível do Agente
|
||
|
||
Passe caminhos de diretório de skills para um agente:
|
||
|
||
```python
|
||
from crewai import Agent
|
||
|
||
agent = Agent(
|
||
role="Researcher",
|
||
goal="Find relevant information",
|
||
backstory="An expert researcher.",
|
||
skills=["./skills"], # descobre todas as skills neste diretório
|
||
)
|
||
```
|
||
|
||
### Skills no Nível do Crew
|
||
|
||
Caminhos de skills no crew são mesclados em todos os agentes:
|
||
|
||
```python
|
||
from crewai import Crew
|
||
|
||
crew = Crew(
|
||
agents=[agent],
|
||
tasks=[task],
|
||
skills=["./skills"],
|
||
)
|
||
```
|
||
|
||
### Skills Pré-carregadas
|
||
|
||
Você também pode passar objetos `Skill` diretamente:
|
||
|
||
```python
|
||
from pathlib import Path
|
||
from crewai.skills import discover_skills, activate_skill
|
||
|
||
skills = discover_skills(Path("./skills"))
|
||
activated = [activate_skill(s) for s in skills]
|
||
|
||
agent = Agent(
|
||
role="Researcher",
|
||
goal="Find relevant information",
|
||
backstory="An expert researcher.",
|
||
skills=activated,
|
||
)
|
||
```
|
||
|
||
## Como as Skills São Carregadas
|
||
|
||
Skills carregam progressivamente — apenas os dados necessários em cada etapa são lidos:
|
||
|
||
| Etapa | O que é carregado | Quando |
|
||
| :--------------- | :------------------------------------------------ | :------------------ |
|
||
| Descoberta | Nome, descrição, campos do frontmatter | `discover_skills()` |
|
||
| Ativação | Texto completo do corpo do SKILL.md | `activate_skill()` |
|
||
|
||
Durante a execução normal do agente, skills são automaticamente descobertas e ativadas. Os diretórios `scripts/`, `references/` e `assets/` estão disponíveis no `path` da skill para agentes que precisam referenciar arquivos diretamente.
|