Skip to content

docs: rewrite README to match wrapper documentation standard#39

Open
sayalibhavsar wants to merge 1 commit into
mainfrom
docs/rewrite-readme-standard
Open

docs: rewrite README to match wrapper documentation standard#39
sayalibhavsar wants to merge 1 commit into
mainfrom
docs/rewrite-readme-standard

Conversation

@sayalibhavsar

Copy link
Copy Markdown

Summary

  • Rewrites README to follow the autohpl-wrapper documentation structure
  • Removes pbench references
  • Adds missing general_setup options (--tools_git, --sysname, --sys_type, --run_user, --host_config, --home_parent, --tuned_setting, --use_pcp)
  • Adds detailed sections: What the Script Does, Dependencies, Examples, Output Files, Result Schema, Return Codes, Notes

Closes #38

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@sayalibhavsar, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 1 minute and 8 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

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.

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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 47dff51e-5a41-480d-914a-97456e53bd2e

📥 Commits

Reviewing files that changed from the base of the PR and between 35c9c83 and 1fc0ab0.

📒 Files selected for processing (1)
  • README.md

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.

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.

docs: rewrite README to match wrapper documentation standard

1 participant