mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 21:58:11 +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>
101 lines
2.9 KiB
Plaintext
101 lines
2.9 KiB
Plaintext
---
|
|
title: "CrewAI AMP"
|
|
description: "Deploy, monitor, and scale your AI agent workflows"
|
|
icon: "globe"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
CrewAI AMP(Agent Management Platform) provides a platform for deploying, monitoring, and scaling your crews and agents in a production environment.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/crewai-enterprise-dashboard.png"
|
|
alt="CrewAI AMP Dashboard"
|
|
/>
|
|
</Frame>
|
|
|
|
CrewAI AMP extends the power of the open-source framework with features designed for production deployments, collaboration, and scalability. Deploy your crews to a managed infrastructure and monitor their execution in real-time.
|
|
|
|
## Key Features
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Crew Deployments" icon="rocket">
|
|
Deploy your crews to a managed infrastructure with a few clicks
|
|
</Card>
|
|
<Card title="API Access" icon="code">
|
|
Access your deployed crews via REST API for integration with existing
|
|
systems
|
|
</Card>
|
|
<Card title="Observability" icon="chart-line">
|
|
Monitor your crews with detailed execution traces and logs
|
|
</Card>
|
|
<Card title="Tool Repository" icon="toolbox">
|
|
Publish and install tools to enhance your crews' capabilities
|
|
</Card>
|
|
<Card title="Webhook Streaming" icon="webhook">
|
|
Stream real-time events and updates to your systems
|
|
</Card>
|
|
<Card title="Crew Studio" icon="paintbrush">
|
|
Create and customize crews using a no-code/low-code interface
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Deployment Options
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="GitHub Integration" icon="github">
|
|
Connect directly to your GitHub repositories to deploy code
|
|
</Card>
|
|
<Card title="Crew Studio" icon="palette">
|
|
Deploy crews created through the no-code Crew Studio interface
|
|
</Card>
|
|
<Card title="CLI Deployment" icon="terminal">
|
|
Use the CrewAI CLI for more advanced deployment workflows
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Getting Started
|
|
|
|
<Steps>
|
|
<Step title="Sign up for an account">
|
|
Create your account at [app.crewai.com](https://app.crewai.com)
|
|
<Card title="Sign Up" icon="user" href="https://app.crewai.com/signup">
|
|
Sign Up
|
|
</Card>
|
|
</Step>
|
|
<Step title="Build your first crew">
|
|
Use code or Crew Studio to build your crew
|
|
<Card
|
|
title="Build Crew"
|
|
icon="paintbrush"
|
|
href="/en/enterprise/guides/build-crew"
|
|
>
|
|
Build Crew
|
|
</Card>
|
|
</Step>
|
|
<Step title="Deploy your crew">
|
|
Deploy your crew to the Enterprise platform
|
|
<Card
|
|
title="Deploy Crew"
|
|
icon="rocket"
|
|
href="/en/enterprise/guides/deploy-crew"
|
|
>
|
|
Deploy Crew
|
|
</Card>
|
|
</Step>
|
|
<Step title="Access your crew">
|
|
Integrate with your crew via the generated API endpoints
|
|
<Card
|
|
title="API Access"
|
|
icon="code"
|
|
href="/en/enterprise/guides/kickoff-crew"
|
|
>
|
|
Use the Crew API
|
|
</Card>
|
|
</Step>
|
|
</Steps>
|
|
|
|
For detailed instructions, check out our [deployment guide](/en/enterprise/guides/deploy-crew) or click the button below to get started.
|