mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +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>
113 lines
3.4 KiB
Plaintext
113 lines
3.4 KiB
Plaintext
---
|
|
title: "Exportação de Componentes React"
|
|
description: "Aprenda como exportar e integrar componentes React do CrewAI AMP em suas aplicações"
|
|
icon: "react"
|
|
mode: "wide"
|
|
---
|
|
|
|
Este guia explica como exportar crews do CrewAI AMP como componentes React e integrá-los às suas próprias aplicações.
|
|
|
|
## Exportando um Componente React
|
|
|
|
<Steps>
|
|
<Step title="Exporte o Componente">
|
|
Clique no menu de opções (três pontos à direita do seu crew implantado), selecione a opção de exportação e salve o arquivo localmente. Usaremos o arquivo `CrewLead.jsx` como exemplo.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/export-react-component.png" alt="Exportar Componente React" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Configurando seu Ambiente React
|
|
|
|
Para executar este componente React localmente, você precisará configurar um ambiente de desenvolvimento React e integrar este componente em um projeto React.
|
|
|
|
<Steps>
|
|
<Step title="Instale o Node.js">
|
|
- Baixe e instale o Node.js no site oficial: https://nodejs.org/
|
|
- Escolha a versão LTS (Long Term Support) para maior estabilidade.
|
|
</Step>
|
|
|
|
<Step title="Crie um novo projeto React">
|
|
- Abra o Prompt de Comando ou PowerShell
|
|
- Navegue até o diretório onde deseja criar seu projeto
|
|
- Execute o seguinte comando para criar um novo projeto React:
|
|
|
|
```bash
|
|
npx create-react-app my-crew-app
|
|
```
|
|
- Entre no diretório do projeto:
|
|
|
|
```bash
|
|
cd my-crew-app
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Instale as dependências necessárias">
|
|
```bash
|
|
npm install react-dom
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Crie o componente CrewLead">
|
|
- Mova o arquivo baixado `CrewLead.jsx` para a pasta `src` do seu projeto.
|
|
</Step>
|
|
|
|
<Step title="Modifique seu App.js para usar o componente CrewLead">
|
|
- Abra o arquivo `src/App.js`
|
|
- Substitua o conteúdo por algo semelhante a isso:
|
|
|
|
```jsx
|
|
import React from 'react';
|
|
import CrewLead from './CrewLead';
|
|
|
|
function App() {
|
|
return (
|
|
<div className="App">
|
|
<CrewLead baseUrl="YOUR_API_BASE_URL" bearerToken="YOUR_BEARER_TOKEN" />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default App;
|
|
```
|
|
- Substitua `YOUR_API_BASE_URL` e `YOUR_BEARER_TOKEN` pelos valores reais da sua API.
|
|
</Step>
|
|
|
|
<Step title="Inicie o servidor de desenvolvimento">
|
|
- No diretório do seu projeto, execute:
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
- Isso iniciará o servidor de desenvolvimento, e seu navegador padrão será aberto automaticamente em http://localhost:3000, onde você verá sua aplicação React rodando.
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Personalização
|
|
|
|
Você pode então personalizar o `CrewLead.jsx` para adicionar cor, título etc.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/customise-react-component.png"
|
|
alt="Personalizar Componente React"
|
|
/>
|
|
</Frame>
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/customise-react-component-2.png"
|
|
alt="Personalizar Componente React"
|
|
/>
|
|
</Frame>
|
|
|
|
## Próximos Passos
|
|
|
|
- Personalize o estilo do componente para combinar com o design da sua aplicação
|
|
- Adicione props adicionais para configuração
|
|
- Integre com o gerenciamento de estado da sua aplicação
|
|
- Adicione tratamento de erros e estados de carregamento
|