docs(evals): add README with usage examples and options reference

[nuthalapativarun]

PR Checklist

• Commit message follows guidelines (conventional commits: <type>(<scope>): <description>)

Bugs / Features

• Related issue(s) linked
• Tests for the changes have been added
• Docs have been added / updated
• Changesets have been added (pnpm changeset)

What is the current behavior?

@voltagent/evals has no README, so users have no documentation for createExperiment/runExperiment or how scorers and VoltOps datasets fit together.

What is the new behavior?

Adds a README covering installation, defining and running an experiment, RunExperimentOptions, scorers, VoltOps integration, and a pointer to the with-offline-evals example.

Notes for reviewers

Usage example is adapted from the existing examples/with-offline-evals example to keep it accurate. Mirrors the style/structure of the recently added @voltagent/server-core README (#1331).

---

Summary by cubic

Add a README for @voltagent/evals that covers installation (now includes @voltagent/core) and running experiments with createExperiment/runExperiment. It documents RunExperimentOptions, scorer setup from @voltagent/scorers, VoltOps datasets and reporting via @voltagent/sdk, and links to examples/with-offline-evals.

^{Written for commit 004f4e8. Summary will update on new commits.}

Summary by CodeRabbit

• Documentation
  • Added comprehensive README documentation for the evals package, including installation instructions, usage examples, configuration options, and integration guidance.

[changeset-bot]

🦋 Changeset detected

Latest commit: 004f4e8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@voltagent/evals	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: edd36ba3-6442-438e-ac1f-73bf0ae0af5f

📥 Commits

Reviewing files that changed from the base of the PR and between f59630f and 004f4e8.

📒 Files selected for processing (1)

• packages/evals/README.md

✅ Files skipped from review due to trivial changes (1)

• packages/evals/README.md

---

📝 Walkthrough

Walkthrough

A new packages/evals/README.md documents @voltagent/evals usage, options, scorers, and VoltOps integration. A corresponding .changeset/evals-readme.md adds a patch release note for the documentation update.

Changes

@voltagent/evals README and changeset

Layer / File(s)	Summary
README documentation and changeset entry packages/evals/README.md, .changeset/evals-readme.md	Adds the full README for @voltagent/evals with installation instructions, a TypeScript usage example, a RunExperimentOptions reference table, scorer guidance, VoltOps integration notes, and an MIT license section. The changeset entry records this as a patch release.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• VoltAgent/voltagent#970: Documents runExperiment and voltOpsClient, which aligns with the same evals API surface described here.

Poem

A rabbit hopped by with a README bright,
For evals and scorers, a tidy delight.
A patch note too, small and neat,
For VoltOps flows and examples complete.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly names the docs update for @voltagent/evals and matches the main change.
Description check	✅ Passed	The description mostly follows the template and includes checklist items, behavior sections, and reviewer notes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[cubic-dev-ai]

1 issue found across 2 files

<sub>Reply with feedback, questions, or to request a fix.

Re-trigger cubic</sub>

[nuthalapativarun]

Fixed — added @voltagent/core to the install command so users can run the quickstart example (which imports Agent from @voltagent/core) without hitting import errors.