docs: fix argus doc command and font lint#68
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 2 minutes and 33 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f9ba345724
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| git diff HEAD~1 | npx argus-ai review --repo . | ||
| git diff HEAD~1 | npx argus review --repo . |
There was a problem hiding this comment.
These examples now use npx argus, but this repo publishes the npm package as argus-ai (npm/package.json), so in a clean environment npx will try to resolve package argus instead of this project and the quick-start flow can fail or run the wrong tool. This specifically impacts first-time users following the README install/review commands without a prior global install.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to align CLI usage examples and styling with current linting/conventions.
Changes:
- Adjusts README command examples to use
argusinstead ofargus-ai. - Removes quotes around the single-word
Sorafont family indocs/styles.cssto satisfy font-family linting.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Updates CLI command examples shown to users. |
| docs/styles.css | Tweaks font-family formatting to avoid lint issues. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```bash | ||
| git diff HEAD~1 | npx argus-ai review --repo . | ||
| git diff HEAD~1 | npx argus review --repo . |
There was a problem hiding this comment.
npx argus ... is likely incorrect here: the npm package is named argus-ai (it only exposes a bin named argus). With npx, the argument is treated as the package/command to resolve, so npx argus will try to run/install an argus npm package instead of argus-ai. Consider using npx argus-ai ... or npx -p argus-ai argus ... (or use argus ... after a global install).
| ```bash | ||
| # 1. Install via npm | ||
| npx argus-ai init # creates .argus.toml | ||
| npx argus init # creates .argus.toml |
There was a problem hiding this comment.
npx argus init will not run the argus binary from this repo’s npm package (argus-ai); npx will try to resolve an argus package instead. Use npx argus-ai init or npx -p argus-ai argus init (or document npm i -g argus-ai followed by running argus init).
|
|
||
| # 3. Review your changes | ||
| git diff HEAD~1 | npx argus-ai review --repo . | ||
| git diff HEAD~1 | npx argus review --repo . |
There was a problem hiding this comment.
Same issue as above: git diff ... | npx argus review will not reliably invoke this project’s CLI because the npm package name is argus-ai. Prefer git diff ... | npx argus-ai review ... or git diff ... | npx -p argus-ai argus review ... (or git diff ... | argus review ... after global install).
|
|
||
| ```bash | ||
| npx argus-ai --help | ||
| npx argus --help |
There was a problem hiding this comment.
npx argus --help has the same resolution problem: the npm package is argus-ai, while argus is the installed binary name. Either keep npx argus-ai --help, or switch this section to npm install -g argus-ai followed by argus --help (or npx -p argus-ai argus --help).
Summary
Verification
font-family: "Sora"ornpx argus-aiin the touched files