Skip to content

Add auto-doc verification and report structure checks#26

Merged
jrenaldi79 merged 1 commit intomainfrom
claude/robust-autodoc-eval
Mar 24, 2026
Merged

Add auto-doc verification and report structure checks#26
jrenaldi79 merged 1 commit intomainfrom
claude/robust-autodoc-eval

Conversation

@jrenaldi79
Copy link
Copy Markdown
Owner

Summary

Three new grader checks adapted from readiness eval patterns:

  1. generate-docs.js --check — Runs the auto-doc script in check mode against the project. Verifies AUTO markers match the actual filesystem, catching hand-written content that doesn't reflect reality.
  2. Setup report structure — Verifies setup-report.md has "What Was Installed", "Verification Results", and "Key Commands" sections (mirrors readiness grader's section checks).
  3. Condensed settings checks to stay under 300 lines.

Test plan

  • npx jest --config '{}' tests/scripts/ — 112 tests pass
  • Grader runs generate-docs.js --check as a subprocess with 10s timeout

https://claude.ai/code/session_01Hbxy31TkbujzukGFSxLcPw

Three new checks adapted from readiness eval patterns:
1. Run generate-docs.js --check to verify AUTO markers match the
   actual filesystem (catches hand-written vs script-generated content)
2. Verify setup-report.md has required sections: What Was Installed,
   Verification Results, Key Commands
3. Condensed settings checks to stay under 300 lines

https://claude.ai/code/session_01Hbxy31TkbujzukGFSxLcPw
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2026

Warning

Rate limit exceeded

@jrenaldi79 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 69742ef9-3d81-4ee5-99a1-77048aa81ed8

📥 Commits

Reviewing files that changed from the base of the PR and between ba82ff9 and 8705d48.

📒 Files selected for processing (1)
  • tests/evals/setup-grader.js
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/robust-autodoc-eval

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 and usage tips.

@jrenaldi79 jrenaldi79 merged commit e6d4de8 into main Mar 24, 2026
1 of 5 checks passed
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