mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38: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>
106 lines
4.2 KiB
Plaintext
106 lines
4.2 KiB
Plaintext
---
|
||
title: "CrewAI Documentation"
|
||
description: "Build collaborative AI agents, crews, and flows — production ready from day one."
|
||
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 }}>Ship multi‑agent systems with confidence</h1>
|
||
<p style={{ color: 'var(--mint-text-2)' }}>
|
||
Design agents, orchestrate crews, and automate flows with guardrails, memory, knowledge, and observability baked in.
|
||
</p>
|
||
</div>
|
||
|
||
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' }}>
|
||
<a className="button button-primary" href="/en/quickstart">Get started</a>
|
||
<a className="button" href="/en/changelog">View changelog</a>
|
||
<a className="button" href="/en/api-reference/introduction">API Reference</a>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div style={{ marginTop: 32 }} />
|
||
|
||
## Get started
|
||
|
||
<CardGroup cols={3}>
|
||
<Card title="Introduction" href="/en/introduction" icon="sparkles">
|
||
Overview of CrewAI concepts, architecture, and what you can build with agents, crews, and flows.
|
||
</Card>
|
||
<Card title="Installation" href="/en/installation" icon="wrench">
|
||
Install via `uv`, configure API keys, and set up the CLI for local development.
|
||
</Card>
|
||
<Card title="Quickstart" href="/en/quickstart" icon="rocket">
|
||
Spin up your first crew in minutes. Learn the core runtime, project layout, and dev loop.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
## Build the basics
|
||
|
||
<CardGroup cols={3}>
|
||
<Card title="Agents" href="/en/concepts/agents" icon="users">
|
||
Compose agents with tools, memory, knowledge, and structured outputs using Pydantic. Includes templates and best practices.
|
||
</Card>
|
||
<Card title="Flows" href="/en/concepts/flows" icon="arrow-progress">
|
||
Orchestrate start/listen/router steps, manage state, persist execution, and resume long-running workflows.
|
||
</Card>
|
||
<Card title="Tasks & Processes" href="/en/concepts/tasks" icon="check">
|
||
Define sequential, hierarchical, or hybrid processes with guardrails, callbacks, and human-in-the-loop triggers.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
## Enterprise journey
|
||
|
||
<CardGroup cols={3}>
|
||
<Card title="Deploy automations" href="/en/enterprise/features/automations" icon="server">
|
||
Manage environments, redeploy safely, and monitor live runs directly from the Enterprise console.
|
||
</Card>
|
||
<Card title="Triggers & Flows" href="/en/enterprise/guides/automation-triggers" icon="bolt">
|
||
Connect Gmail, Slack, Salesforce, and more. Pass trigger payloads into crews and flows automatically.
|
||
</Card>
|
||
<Card title="Team management" href="/en/enterprise/guides/team-management" icon="users-gear">
|
||
Invite teammates, configure RBAC, and control access to production automations.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
## What’s new
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="Triggers overview" href="/en/enterprise/guides/automation-triggers" icon="sparkles">
|
||
Unified overview for Gmail, Drive, Outlook, Teams, OneDrive, HubSpot, and more — now with sample payloads and crews.
|
||
</Card>
|
||
<Card title="Integration tools" href="/en/tools/integration/overview" icon="plug">
|
||
Call existing CrewAI automations or Amazon Bedrock Agents directly from your crews using the updated integration toolkit.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
<Callout title="Explore real-world patterns" icon="github">
|
||
Browse the <a href="/en/examples/cookbooks">examples and cookbooks</a> for end-to-end reference implementations across agents, flows, and enterprise automations.
|
||
</Callout>
|
||
|
||
## Stay connected
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="Star us on GitHub" href="https://github.com/crewAIInc/crewAI" icon="star">
|
||
If CrewAI helps you ship faster, give us a star and share your builds with the community.
|
||
</Card>
|
||
<Card title="Join the community" href="https://community.crewai.com" icon="comments">
|
||
Ask questions, showcase workflows, and request features alongside other builders.
|
||
</Card>
|
||
</CardGroup>
|