Skip to content

docs: sync rule count 385 -> 399 across user-facing docs - #721

Merged
avifenesh merged 3 commits into
mainfrom
docs/fix-rule-count-drift
Apr 14, 2026
Merged

docs: sync rule count 385 -> 399 across user-facing docs#721
avifenesh merged 3 commits into
mainfrom
docs/fix-rule-count-drift

Conversation

@avifenesh

@avifenesh avifenesh commented Apr 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Update rule count from 385 to 399 in 14 user-facing locations (source of truth is knowledge-base/rules.json which has 399)
  • Fix first-person plural "we" -> "I" in CONTRIBUTING.md and website/docs/contributing.md (I am the sole maintainer)

Why

Doc drift surfaced by a workspace-wide repo-intel scan. Rule count had been updated in rules.json (source of truth) but not propagated to READMEs, SPEC, extensions, skills, plugin manifests, MCP server instructions, website docs, and knowledge-base stats.

Scope

Docs, manifests, and a single Rust file (crates/agnix-mcp/src/main.rs) where the MCP server's instruction string contained the stale count. No functional code changes - only string literals and markdown.

Files touched (16):

  • Root: README.md, SPEC.md, CONTRIBUTING.md
  • Crates: crates/agnix-mcp/src/main.rs
  • Editors: editors/vscode/package.json, editors/zed/README.md
  • Knowledge base: knowledge-base/INDEX.md, knowledge-base/README.md
  • npm: npm/README.md
  • Plugin: plugin/.claude-plugin/plugin.json, plugin/commands/agnix.md, plugin/skills/agnix/SKILL.md
  • Skills: skills/agnix/SKILL.md
  • Website: website/docs/contributing.md, website/docs/getting-started.md, website/docs/intro.md

Test plan

  • Pre-push hook passed: cargo clippy --workspace --all-features -- -D warnings && cargo test --workspace (all suites passed locally)
  • CI passes
  • Website builds

Generated by doc-drift review.


Note

Low Risk
Updates are limited to documentation and user-facing string literals (including MCP server instructions), with no changes to validation behavior or APIs.

Overview
Synchronizes all user-facing references of the validation rule count from 385 to 399 across README/spec/knowledge-base docs, website pages, editor extension manifests, and plugin/skill metadata.

Also adjusts contribution messaging from "we" to "I" in CONTRIBUTING.md and website/docs/contributing.md to reflect single-maintainer ownership, and updates the MCP server ServerInfo.instructions strings to match the new count.

Reviewed by Cursor Bugbot for commit e5cc699. Configure here.

Rule count in knowledge-base/rules.json is 399 but user-facing locations
still said 385. This brings them into alignment with the source of truth:

- READMEs (root, npm, editors/zed, knowledge-base)
- SPEC.md header and architecture section
- Website docs (intro, getting-started, contributing)
- Plugin manifests (.claude-plugin/plugin.json, commands/agnix.md, SKILL.md)
- knowledge-base/INDEX.md (header, nav, diagram, stats block)
- crates/agnix-mcp/src/main.rs server instructions
- editors/vscode/package.json description

Also fix first-person plural in CONTRIBUTING.md and website contributing
docs - I am the sole maintainer so "we welcome" -> "I welcome", etc.
Copilot AI review requested due to automatic review settings April 14, 2026 23:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates user-facing documentation/manifests to reflect the current validation rule count (399, per knowledge-base/rules.json) and adjusts contributor-facing wording to use first-person singular where appropriate.

Changes:

  • Sync “385 rules” → “399 rules” across docs, READMEs, editor/plugin manifests, and MCP server instructions.
  • Update contributing copy from “we” → “I” in contributing docs.
  • Refresh a few knowledge-base summary lines to match the new rule count.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
website/docs/intro.md Updates site intro metadata and bullets to “399 rules”.
website/docs/getting-started.md Updates “Rules Reference” link blurb to “399 rules”.
website/docs/contributing.md Updates rule count and switches “we” → “I”.
skills/agnix/SKILL.md Updates skill description to “399 rules”.
plugin/skills/agnix/SKILL.md Updates plugin skill description to “399 rules”.
plugin/commands/agnix.md Updates command frontmatter description to “399 rules”.
plugin/.claude-plugin/plugin.json Updates plugin manifest description to “399 rules”.
npm/README.md Updates marketing line to “399 rules”.
knowledge-base/README.md Updates knowledge-base navigation blurb to “399 rules”.
knowledge-base/INDEX.md Updates multiple index references to “399 rules” (but one total remains stale; see comments).
editors/zed/README.md Updates Zed extension README to “399 rules”.
editors/vscode/package.json Updates VS Code extension description to “399 rules”.
crates/agnix-mcp/src/main.rs Updates MCP server doc/instructions strings to “399 rules” (but count remains hardcoded and inconsistent with other text; see comments).
SPEC.md Updates spec header/structure references to “399 rules”.
README.md Updates main README copy to “399 rules”.
CONTRIBUTING.md Switches “We welcome…” → “I welcome…” in community feedback section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread knowledge-base/INDEX.md
Comment thread crates/agnix-mcp/src/main.rs Outdated
Comment thread crates/agnix-mcp/src/main.rs Outdated

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the validation rule count from 385 to 399 across the project's documentation, metadata, and source code. Additionally, it updates the contributing guidelines to use first-person singular pronouns. Feedback was provided to update the category count in the Zed editor documentation to ensure consistency with other technical references.

Comment thread editors/zed/README.md Outdated
- knowledge-base/INDEX.md: update TOTAL row 385 -> 399 and fix stale
  per-category counts so row sums match (36 categories, 399 rules)
- crates/agnix-mcp/src/main.rs: use rule_count() for runtime instructions
  string, drop hardcoded numbers from rustdoc and tool descriptions so
  they no longer drift
- editors/zed/README.md: 28 categories -> 36 to match SPEC.md and
  rules.json source of truth
Copilot AI review requested due to automatic review settings April 14, 2026 23:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md
@avifenesh
avifenesh merged commit 33ad219 into main Apr 14, 2026
24 checks passed
@avifenesh
avifenesh deleted the docs/fix-rule-count-drift branch April 14, 2026 23:33
avifenesh added a commit that referenced this pull request Apr 23, 2026
Address review feedback from gemini-code-assist and Copilot on PR #776:

- CHANGELOG: CC-OS validator added 6 rules (not 5 as drafted) - CC-OS-006
  "Invalid Output Style Frontmatter Syntax" was missing. Total now 399 -> 405.
- VS Code description: drop hard-coded rule count (perpetual drift source)
  per Copilot suggestion - matches the "(or avoid embedding a count here to
  prevent future drift)" recommendation.
- 20 user-facing files: bump 399 -> 405 to match knowledge-base/rules.json
  total_rules. Same drift pattern PR #721 fixed; CC-OS rules added without
  doc-sync.
@avifenesh avifenesh mentioned this pull request Apr 23, 2026
7 tasks
avifenesh added a commit that referenced this pull request Apr 23, 2026
* chore: bump version to 0.19.0

* docs: fix rule count drift (399 -> 405) for v0.19.0 release

Address review feedback from gemini-code-assist and Copilot on PR #776:

- CHANGELOG: CC-OS validator added 6 rules (not 5 as drafted) - CC-OS-006
  "Invalid Output Style Frontmatter Syntax" was missing. Total now 399 -> 405.
- VS Code description: drop hard-coded rule count (perpetual drift source)
  per Copilot suggestion - matches the "(or avoid embedding a count here to
  prevent future drift)" recommendation.
- 20 user-facing files: bump 399 -> 405 to match knowledge-base/rules.json
  total_rules. Same drift pattern PR #721 fixed; CC-OS rules added without
  doc-sync.
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