Repository navigation
docs: correct the README files - #1783
Conversation
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: 2c6bec78-ade1-4289-9dd8-5df4747ac791) |
There was a problem hiding this comment.
This is an auto review done by revuto.
Revuto completed the review and found no evidence-backed concerns.
|
Self-review (fresh context): checked every changed line against Verified: Two problems:
|
|
Fresh review findings, both verified against the code and fixed in bd7963a:
|
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: f1ae1db2-c7ed-4916-8a44-ea0f8534de4e) |
There was a problem hiding this comment.
This is an auto review done by revuto.
Revuto completed the review and found no evidence-backed concerns.
README audit against the code at
ed647b0e. Scope: root README plus the npm, PyPI, crate and editor READMEs that ship to users.Corrections
github.com/agent-sh/agnix.nvimreturns 404 and the repo does not exist. The plugin lives in this repo (lua/agnix/init.luashim pluseditors/neovim/), so the link now points ateditors/neovim.validate_project_rulesreturnsLintResult<Vec<Diagnostic>>(crates/agnix-core/src/pipeline.rs:887), soresult.diagnosticsdoes not compile (E0609: no field diagnostics on type Vec<Diagnostic>, checked withcargo check --example).DiagnosticLevelhas noDisplayimpl either. The example now iterates the Vec and prints the level with{:?}; the corrected version compiles..agnix.tomlexample.TargetToolandSeverityLeveldeserialize PascalCase variants with no serde rename (crates/agnix-core/src/config.rs:708,972), sotarget = "claude-code"andseverity = "warning"do not parse.targetis also deprecated. Nowtools = ["claude-code"]andseverity = "Warning", matchingdocs/CONFIGURATION.md.knowledge-base/rules.json:total_rules757, 46categories).extension.tomlregisters only Markdown and JSON.language_server_commandalways uses the downloaded binary (editors/zed/src/lib.rs:253). Installingagnix-lspby hand does not help, so the section now says that.npm install -g agnixandbrew install agnixdo not installagnix-lsp. The npm package exposes only theagnixbin and downloads the CLI tarball (contents:agnixonly); the tap formula runscargo installoncrates/agnix-clionly. Removed npm from the Neovim LSP install block. In VS Code, replaced the Homebrew line with the release download and one line saying Homebrew, npm and pip ship only the CLI.agnix.rules.pi/antigravity/grokCodetoggles to the rule table (all inpackage.jsonandfilePatterns.ts). Preview Fixes has a keybinding inpackage.json(ctrl+shift+p ctrl+shift+f); the table said none.explainandtoolssubcommands, the full--targetvalue list (pi|antigravity|grok-code|generic|claude-code|cursor|codex|kiro),--fix-unsafe, thegithubformat and[PATHS]..., all fromcrates/agnix-cli/src/main.rs.agnix explainandagnix tools check|detect.Checked and correct
Install commands and registries (npm, PyPI and crates.io at 0.60.2, Homebrew tap at 0.60.2,
v0action tag), the per-tool rule counts in the root table (each matchesrules.jsonby prefix), root CLI flags and the--targetvalues, the action inputs, the npm and Python API names and signatures, PyPI wheel platforms, JetBrains requirements (since-build 233, JVM 17), the Neovim defaults and commands, the agnix-rules constants, the agnix-lsp source tree. External links answer 200-399, except bot-gated ones (npmjs, the GitHub user-attachments video, augmentcode, stargazers when anonymous).Checks
bash scripts/preflight.shpasses (format, bookkeeping, count tables, locale, instruction and schema copies). The--fullrun was skipped because this PR changes only docs. Self-review is pending; no revuto run yet.Note
Low Risk
Documentation and comment-only changes with no runtime or validation logic modifications.
Overview
This PR audits and fixes user-facing documentation (root README, crate/npm/editor READMEs, CHANGELOG) so examples, links, and command lists match the codebase at the reviewed commit.
The root README replaces the sponsor blockquote with a centered badge and fixes the Neovim link to
editors/neovimin-repo instead of a missing external repo.Editor and package READMEs are brought in line with the binary: the agnix-core
validate_project_rulessample compiles (iterate the returnedVec<Diagnostic>, print level with{:?}); Zed’s.agnix.tomlexample uses validtools/severitykeys and updated rule counts; Zed no longer documents npm/manual PATHagnix-lspinstalls. Neovim/VS Code clarify that npm/Homebrew ship the CLI only, notagnix-lsp. VS Code docs add Pi, Antigravity, and Grok Code support and the Preview Fixes keybinding. npm and agnix-cli READMEs documentexplain,tools, expanded--targetvalues, and other flags frommain.rs.Minor code comments in
agnix-clirename.tool_versionsto[tool_versions]in help text only.Reviewed by Cursor Bugbot for commit bd7963a. Configure here.