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>
135 lines
3.4 KiB
Plaintext
135 lines
3.4 KiB
Plaintext
---
|
||
title: Neatlogs Integration
|
||
description: Understand, debug, and share your CrewAI agent runs
|
||
icon: magnifying-glass-chart
|
||
mode: "wide"
|
||
---
|
||
|
||
# Introduction
|
||
|
||
Neatlogs helps you **see what your agent did**, **why**, and **share it**.
|
||
|
||
It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration.
|
||
|
||
## Why use Neatlogs?
|
||
|
||
CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context — not just errors.
|
||
|
||
Neatlogs lets you:
|
||
|
||
- Follow the full decision path
|
||
- Add feedback directly on steps
|
||
- Chat with the trace using AI assistant
|
||
- Share runs publicly for feedback
|
||
- Turn insights into tasks
|
||
|
||
All in one place.
|
||
|
||
Manage your traces effortlessly
|
||
|
||
|
||
|
||
|
||
The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to debug.
|
||
|
||
|
||
|
||
|
||
|
||
## Core Features
|
||
|
||
- **Trace Viewer**: Track thoughts, tools, and decisions in sequence
|
||
- **Inline Comments**: Tag teammates on any trace step
|
||
- **Feedback & Evaluation**: Mark outputs as correct or incorrect
|
||
- **Error Highlighting**: Automatic flagging of API/tool failures
|
||
- **Task Conversion**: Convert comments into assigned tasks
|
||
- **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot
|
||
- **Public Sharing**: Publish trace links to your community
|
||
|
||
## Quick Setup with CrewAI
|
||
|
||
<Steps>
|
||
<Step title="Sign Up & Get API Key">
|
||
Visit [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, copy the API key.
|
||
</Step>
|
||
<Step title="Install SDK">
|
||
```bash
|
||
pip install neatlogs
|
||
```
|
||
(Latest version 0.8.0, Python 3.8+; MIT license)
|
||
</Step>
|
||
<Step title="Initialize Neatlogs">
|
||
Before starting Crew agents, add:
|
||
|
||
```python
|
||
import neatlogs
|
||
neatlogs.init("YOUR_PROJECT_API_KEY")
|
||
```
|
||
|
||
Agents run as usual. Neatlogs captures everything automatically.
|
||
|
||
</Step>
|
||
</Steps>
|
||
|
||
|
||
|
||
## Under the Hood
|
||
|
||
According to GitHub, Neatlogs:
|
||
|
||
- Captures thoughts, tool calls, responses, errors, and token stats
|
||
- Supports AI-powered task generation and robust evaluation workflows
|
||
|
||
All with just two lines of code.
|
||
|
||
|
||
|
||
## Watch It Work
|
||
|
||
### 🔍 Full Demo (4 min)
|
||
|
||
<iframe
|
||
className="w-full aspect-video rounded-xl"
|
||
src="https://www.youtube.com/embed/8KDme9T2I7Q?si=b8oHteaBwFNs_Duk"
|
||
title="NeatLogs overview"
|
||
frameBorder="0"
|
||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||
allowFullScreen
|
||
></iframe>
|
||
|
||
### ⚙️ CrewAI Integration (30 s)
|
||
|
||
<iframe
|
||
className="w-full aspect-video rounded-xl"
|
||
src="https://www.loom.com/embed/9c78b552af43452bb3e4783cb8d91230?sid=e9d7d370-a91a-49b0-809e-2f375d9e801d"
|
||
title="Loom video player"
|
||
frameBorder="0"
|
||
allowFullScreen
|
||
></iframe>
|
||
|
||
|
||
|
||
## Links & Support
|
||
|
||
- 📘 [Neatlogs Docs](https://docs.neatlogs.com/)
|
||
- 🔐 [Dashboard & API Key](https://app.neatlogs.com/)
|
||
- 🐦 [Follow on Twitter](https://twitter.com/neatlogs)
|
||
- 📧 Contact: hello@neatlogs.com
|
||
- 🛠 [GitHub SDK](https://github.com/NeatLogs/neatlogs)
|
||
|
||
|
||
|
||
## TL;DR
|
||
|
||
With just:
|
||
|
||
```bash
|
||
pip install neatlogs
|
||
|
||
import neatlogs
|
||
neatlogs.init("YOUR_API_KEY")
|
||
|
||
You can now capture, understand, share, and act on your CrewAI agent runs in seconds.
|
||
No setup overhead. Full trace transparency. Full team collaboration.
|
||
```
|