Skip to content

docs: correct the README files - #1783

Merged
avifenesh merged 2 commits into
mainfrom
docs/readme-audit
Oct 31, 2026
Merged

avifenesh merged 2 commits into
mainfrom
docs/readme-audit

Conversation

@avifenesh

@avifenesh avifenesh commented Oct 31, 2026 •

Copy link
Copy Markdown
Collaborator

README audit against the code at ed647b0e. Scope: root README plus the npm, PyPI, crate and editor READMEs that ship to users.

Corrections

  • Root README, sponsor note. Replaced the sponsor blockquote with the centered sponsor badge block, same place. The Tiyuvta blockquote is unchanged.
  • Root README, Neovim link. github.com/agent-sh/agnix.nvim returns 404 and the repo does not exist. The plugin lives in this repo (lua/agnix/init.lua shim plus editors/neovim/), so the link now points at editors/neovim.
  • agnix-core README, project-rules example. validate_project_rules returns LintResult<Vec<Diagnostic>> (crates/agnix-core/src/pipeline.rs:887), so result.diagnostics does not compile (E0609: no field diagnostics on type Vec<Diagnostic>, checked with cargo check --example). DiagnosticLevel has no Display impl either. The example now iterates the Vec and prints the level with {:?}; the corrected version compiles.
  • Zed README, .agnix.toml example. TargetTool and SeverityLevel deserialize PascalCase variants with no serde rename (crates/agnix-core/src/config.rs:708,972), so target = "claude-code" and severity = "warning" do not parse. target is also deprecated. Now tools = ["claude-code"] and severity = "Warning", matching docs/CONFIGURATION.md.
  • Zed README, rule count. "416 validation rules across 40 categories" is now "757 validation rules across 46 categories" (knowledge-base/rules.json: total_rules 757, 46 categories).
  • Zed README, MDC support. Removed "MDC file type support for Cursor rules": the extension's MDC language was removed in d22a5cf (fix(zed): remove mdc language definition per upstream review #559) and extension.toml registers only Markdown and JSON.
  • Zed README, manual LSP binary. The extension never looks on PATH: language_server_command always uses the downloaded binary (editors/zed/src/lib.rs:253). Installing agnix-lsp by hand does not help, so the section now says that.
  • Neovim and VS Code READMEs, LSP install. npm install -g agnix and brew install agnix do not install agnix-lsp. The npm package exposes only the agnix bin and downloads the CLI tarball (contents: agnix only); the tap formula runs cargo install on crates/agnix-cli only. 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.
  • VS Code README. Added Pi, Antigravity CLI and Grok Code to the multi-tool line and the agnix.rules.pi / antigravity / grokCode toggles to the rule table (all in package.json and filePatterns.ts). Preview Fixes has a keybinding in package.json (ctrl+shift+p ctrl+shift+f); the table said none.
  • npm README, options block. Added the explain and tools subcommands, the full --target value list (pi|antigravity|grok-code|generic|claude-code|cursor|codex|kiro), --fix-unsafe, the github format and [PATHS]..., all from crates/agnix-cli/src/main.rs.
  • agnix-cli README, commands. Added agnix explain and agnix tools check|detect.
  • CHANGELOG.md. Unreleased entry, as CONTRIBUTING requires for every PR.

Checked and correct

Install commands and registries (npm, PyPI and crates.io at 0.60.2, Homebrew tap at 0.60.2, v0 action tag), the per-tool rule counts in the root table (each matches rules.json by prefix), root CLI flags and the --target values, 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.sh passes (format, bookkeeping, count tables, locale, instruction and schema copies). The --full run 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/neovim in-repo instead of a missing external repo.

Editor and package READMEs are brought in line with the binary: the agnix-core validate_project_rules sample compiles (iterate the returned Vec<Diagnostic>, print level with {:?}); Zed’s .agnix.toml example uses valid tools / severity keys and updated rule counts; Zed no longer documents npm/manual PATH agnix-lsp installs. Neovim/VS Code clarify that npm/Homebrew ship the CLI only, not agnix-lsp. VS Code docs add Pi, Antigravity, and Grok Code support and the Preview Fixes keybinding. npm and agnix-cli READMEs document explain, tools, expanded --target values, and other flags from main.rs.

Minor code comments in agnix-cli rename .tool_versions to [tool_versions] in help text only.

Reviewed by Cursor Bugbot for commit bd7963a. Configure here.

@cursor

cursor Bot commented Oct 31, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot 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)

@revuto-review revuto-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an auto review done by revuto.


Revuto completed the review and found no evidence-backed concerns.

@avifenesh

Copy link
Copy Markdown
Collaborator Author

Self-review (fresh context): checked every changed line against f2510115.

Verified: TargetArg values and order, OutputFormat::Github, --fix-unsafe, [PATHS]..., the explain/tools subcommands and their order in main.rs; validate_project_rules returning LintResult<Vec<Diagnostic>>; PascalCase SeverityLevel, the tools field and deprecated target; 757 rules and 46 categories in rules.json; the Preview Fixes chord and the pi/antigravity/grokCode toggles in package.json; PI-*/AGY-*/GRK-* prefixes in rules.json; extension.toml registering only Markdown and JSON; the tap formula (0.60.2) building only crates/agnix-cli; npm and PyPI shipping only agnix; agnix-lsp-<target>.tar.gz on releases; editors/neovim existing. No em dashes or hedging in the added text.

Two problems:

  1. editors/zed/README.md, "Manual LSP binary": "so the download has to succeed once" is wrong. language_server_binary_path calls zed::latest_github_release (editors/zed/src/lib.rs:150) before it checks for an already verified binary on disk. The in-memory cache does not survive a restart, so every new Zed session has to reach the GitHub releases API, even when the binary is already downloaded. Offline, the server fails to start. Suggested text: "The extension does not use an agnix-lsp on your PATH. It runs the copy it downloads and checks GitHub releases each time Zed starts, so Zed needs network access to start the server."

  2. npm/README.md, tools line: "against .tool_versions in .agnix.toml" names a key that does not exist. The section is [tool_versions], which is what the agnix-cli README in this same PR says. The text was copied from the clap doc comment at crates/agnix-cli/src/main.rs:280, which has the same mistake. Fix both: "Check or detect tool versions against [tool_versions] in .agnix.toml".

@avifenesh

Copy link
Copy Markdown
Collaborator Author

Fresh review findings, both verified against the code and fixed in bd7963a:

  • editors/zed/README.md: language_server_binary_path calls latest_github_release before it looks for a verified binary on disk, and the in-memory cache does not survive a restart. The note now says Zed checks GitHub releases on each start and needs network access to start the server.
  • npm/README.md: the section is [tool_versions], not .tool_versions. Fixed there, in the clap doc comment in crates/agnix-cli/src/main.rs:280 (the source of the copy), and in the same two mistakes in the crates/agnix-cli/src/tools.rs module doc.

@cursor

cursor Bot commented Oct 31, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot 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)

@revuto-review revuto-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an auto review done by revuto.


Revuto completed the review and found no evidence-backed concerns.

@avifenesh
avifenesh merged commit bd7963a into main Oct 31, 2026
18 checks passed
@avifenesh
avifenesh deleted the docs/readme-audit branch October 31, 2026 12:32

This branch was successfully deployed

1 active deployment
github-pages — bd7963a9 Deployed Oct 31, 2026 by avifenesh via Deploy to GitHub Pages #1666
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.

1 participant