Skip to content

Add docs for annotating agent runs#2085

Open
strawgate wants to merge 4 commits into
mainfrom
claude/annotations-feature-flag-rollout-9g08iu
Open

Add docs for annotating agent runs#2085
strawgate wants to merge 4 commits into
mainfrom
claude/annotations-feature-flag-rollout-9g08iu

Conversation

@strawgate

@strawgate strawgate commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

What this adds

A new documentation page for the Annotations feature at docs/reference/advanced/run-annotations/index.md, registered in the nav under Evaluate (next to Evals and Datasets).

Annotations let you review your AI agents' output and label each run with a verdict (pass / neutral / fail), a category, the answer it should have given, a comment, and tags, then triage them across agents and export the results as eval cases.

Page contents

  • Orientation: what annotations are, why you'd use them, and when to reach for live evals instead.
  • Annotate a run: numbered UI steps from the agent Runs tab, with keyboard shortcuts.
  • What you can record: the verdict, category, expected output, comment, and tags fields.
  • Review across agents: the project-wide Annotations page (Agents grid + recent-annotations feed, with verdict/annotator filters).
  • Export annotations as eval cases: the JSON Lines export and how it feeds a dataset.
  • Verify and Troubleshooting sections.

The feature is marked Beta using the standard !!! note "Beta: feedback welcome" admonition. Written to the repo's documentation style guide (sentence-case headings, terms glossed on first use, no em-dashes, no hype words) and grounded in the current UI. Drafted with AI assistance and human-reviewed against the shipped product.

This documents the same feature the platform-side rollout releases from behind its feature flag; the run-annotations walkthrough already points its public_docs frontmatter at this path.

🤖 Generated with Claude Code

https://claude.ai/code/session_01A8uqUP5UYj7vEmofWe4mHW


Generated by Claude Code

Review in cubic

Document the Annotations feature: what it is, when to use it (and when to
reach for live evals instead), how to annotate a run from the agent Runs
tab, the fields you can record, the project-wide Annotations page, and
exporting annotations as eval cases. Includes Verify and Troubleshooting
sections and marks the feature Beta.

Registered in the nav under Evaluate, next to Evals and Datasets.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A8uqUP5UYj7vEmofWe4mHW
@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@strawgate, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 3 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bdfa88f1-e0aa-41ff-b7fb-8c0f0f12e389

📥 Commits

Reviewing files that changed from the base of the PR and between e839965 and 47008c3.

📒 Files selected for processing (1)
  • docs/reference/advanced/run-annotations/index.md
📝 Walkthrough

Walkthrough

Adds a new documentation page for beta Logfire Annotations, covering annotation workflows, fields, review views, JSON Lines exports, verification, troubleshooting, and next steps. Adds the page to the “Evaluate: Live Monitoring” navigation under “Annotate Agent Runs.”

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states the main change: adding documentation for annotating agent runs.
Description check ✅ Passed The description directly matches the new annotations docs page and its documented behaviors.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/annotations-feature-flag-rollout-9g08iu

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/reference/advanced/run-annotations/index.md`:
- Line 9: Update the Slack community link in the annotations documentation to
use the source-relative path ../../../join-slack/ instead of the hard-coded
absolute URL, while leaving the surrounding message and email link unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 84a2c83d-d237-4227-b408-155fe788e9d9

📥 Commits

Reviewing files that changed from the base of the PR and between db9859a and 321ef32.

📒 Files selected for processing (2)
  • docs/reference/advanced/run-annotations/index.md
  • mkdocs.yml
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • pydantic/logfire (manual)
  • pydantic/pydantic-ai (manual)
  • pydantic/platform (auto-detected) → reviewed against branch claude/annotations-feature-flag-rollout-9g08iu instead of the default branch
  • pydantic/pydantic (auto-detected)

Comment thread docs/reference/advanced/run-annotations/index.md Outdated
Replace the hard-coded absolute URL (which carries the deployment-specific
`/docs` prefix) with a source-relative link, matching the repo docs
convention and the existing `faq.md` usage.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A8uqUP5UYj7vEmofWe4mHW
claude added 2 commits July 18, 2026 03:11
Review pass against the shipped UI found three inaccuracies:

- Verdict is not a required field: an annotation can be saved with just a
  comment or tag, so it's described as the headline label with the rest as
  optional context.
- Category and expected output are verdict-conditional (category for
  neutral/fail, expected output for fail); note when each appears.
- Export honors the runs table's verdict/category/tag filters, not the
  annotator chip; the export and troubleshooting text said otherwise.

Also fixed the "no agents" troubleshooting: the 7-day grid window is fixed,
so point users to the Agents page for older agents instead of "widening" it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A8uqUP5UYj7vEmofWe4mHW
Style guide flags "just" as filler; use "only".

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A8uqUP5UYj7vEmofWe4mHW
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants