Skip to content

docs(packages): add README to core, graders, and reporter#128

Merged
sanchitmehtagit merged 1 commit into
mainfrom
docs/package-readmes
Jul 22, 2026
Merged

docs(packages): add README to core, graders, and reporter#128
sanchitmehtagit merged 1 commit into
mainfrom
docs/package-readmes

Conversation

@frederikprijck

Copy link
Copy Markdown
Member

What

Add a README.md to the three published packages that lack one: @a0/evals-core, @a0/evals-graders, and @a0/evals-reporter. @a0/evals already has a comprehensive README and is unchanged.

Why

npm auto-includes a package's own README in its tarball (it does not pull one from the monorepo root). Today only @a0/evals ships documentation; the other three would publish with none. Each new README describes the package's purpose, its main exports, and a short usage example, with links back to the monorepo for the full guide.

Example snippets were checked against the actual exported signatures (contains/judge in graders, renderHtml/loadScores in reporter).

Split out from the packaging cleanup so README and license/notice changes review independently.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 49 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 88fa3ce4-ed64-434a-afcf-a8c22a6b7a3f

📥 Commits

Reviewing files that changed from the base of the PR and between 3e91dfe and 81923f0.

📒 Files selected for processing (3)
  • packages/evals-core/README.md
  • packages/evals-graders/README.md
  • packages/evals-reporter/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/package-readmes

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

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

Only @a0/evals had a README; the other three published packages had none.
npm auto-includes a package's own README in its tarball, so without these
files the published packages ship with no documentation. Add a focused
README to each describing its purpose, exports, and usage.

@a0/evals already has a comprehensive README and is unchanged.
@sanchitmehtagit
sanchitmehtagit merged commit a26fa5c into main Jul 22, 2026
6 checks passed
@sanchitmehtagit
sanchitmehtagit deleted the docs/package-readmes branch July 22, 2026 10:08
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