Files
crewAI/docs/edge/pt-BR/index.mdx
Lucas Gomide a237ebabba feat: adopt directory-based docs versioning with Edge channel (#6202)
* 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>
2026-06-17 11:56:59 -04:00

103 lines
4.3 KiB
Plaintext

---
title: "CrewAI Documentação"
description: "Construa agentes colaborativos, crews e flows — prontos para produção desde o primeiro dia."
icon: "house"
mode: "wide"
---
<div
style={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 20,
textAlign: 'center',
padding: '48px 24px',
borderRadius: 16,
background: 'linear-gradient(180deg, rgba(235,102,88,0.12) 0%, rgba(201,76,60,0.08) 100%)',
border: '1px solid rgba(235,102,88,0.18)'
}}
>
<img src="/images/crew_only_logo.png" alt="CrewAI" width="250" height="100" />
<div style={{ maxWidth: 720 }}>
<h1 style={{ marginBottom: 12 }}>Construa sistemas multiagentes com confiança</h1>
<p style={{ color: 'var(--mint-text-2)' }}>
Crie agentes, orquestre crews e automatize flows com guardrails, memória, conhecimento e observabilidade integrados.
</p>
</div>
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' }}>
<a className="button button-primary" href="/pt-BR/quickstart">Começar agora</a>
<a className="button button-secondary" href="/pt-BR/changelog">Ver changelog</a>
<a className="button button-secondary" href="/pt-BR/api-reference/introduction">API Reference</a>
</div>
</div>
<div style={{ marginTop: 32 }} />
<CardGroup cols={3}>
<Card title="Introdução" href="/pt-BR/introduction" icon="sparkles">
Visão geral dos conceitos da CrewAI, arquitetura e casos de uso para agentes, crews e flows.
</Card>
<Card title="Instalação" href="/pt-BR/installation" icon="wrench">
Instale com `uv`, configure chaves de API e prepare o CLI para desenvolvimento local.
</Card>
<Card title="Quickstart" href="/pt-BR/quickstart" icon="rocket">
Crie sua primeira crew em poucos minutos. Aprenda o runtime, a estrutura do projeto e o loop de desenvolvimento.
</Card>
</CardGroup>
## Fundamentos
<CardGroup cols={3}>
<Card title="Agentes" href="/pt-BR/concepts/agents" icon="users">
Modele agentes com ferramentas, memória, conhecimento e saídas estruturadas. Inclui templates e boas práticas.
</Card>
<Card title="Flows" href="/pt-BR/concepts/flows" icon="arrow-progress">
Orquestre start/listen/router, gerencie estado, persista execuções e retome processos longos.
</Card>
<Card title="Tarefas & Processos" href="/pt-BR/concepts/tasks" icon="check">
Defina processos sequenciais, hierárquicos ou híbridos com guardrails, callbacks e intervenção humana.
</Card>
</CardGroup>
## Jornada Enterprise
<CardGroup cols={3}>
<Card title="Automations" href="/pt-BR/enterprise/features/automations" icon="server">
Gerencie ambientes, faça deploy seguro e monitore execuções ao vivo diretamente no console Enterprise.
</Card>
<Card title="Triggers & Flows" href="/pt-BR/enterprise/guides/automation-triggers" icon="bolt">
Conecte Gmail, Slack, Salesforce e muito mais. Injete payloads dos triggers em crews e flows automaticamente.
</Card>
<Card title="Gestão de times" href="/pt-BR/enterprise/guides/team-management" icon="users-gear">
Convide integrantes, configure RBAC e controle o acesso às automations em produção.
</Card>
</CardGroup>
## Novidades
<CardGroup cols={2}>
<Card title="Visão geral de triggers" href="/pt-BR/enterprise/guides/automation-triggers" icon="sparkles">
Guia unificado para Gmail, Drive, Outlook, Teams, OneDrive, HubSpot e outros — com payloads e crews de exemplo.
</Card>
<Card title="Ferramentas de integração" href="/pt-BR/tools/integration/overview" icon="plug">
Chame automations CrewAI existentes ou agentes do Amazon Bedrock diretamente das suas crews.
</Card>
</CardGroup>
<Callout title="Explore exemplos práticos" icon="github">
Acesse os <a href="/pt-BR/examples/cookbooks">examples e cookbooks</a> para implementações completas envolvendo agentes, flows e automations Enterprise.
</Callout>
## Conecte-se
<CardGroup cols={2}>
<Card title="Star no GitHub" href="https://github.com/crewAIInc/crewAI" icon="star">
Se a CrewAI acelera seu trabalho, deixe uma estrela e compartilhe seus projetos com a comunidade.
</Card>
<Card title="Participe da comunidade" href="https://community.crewai.com" icon="comments">
Tire dúvidas, divulgue workflows e solicite recursos junto a outros builders.
</Card>
</CardGroup>