Tracking issue for bringing the docs in line with the current repo. Each checkbox can become its own sub-issue. Comment to claim one.
Stale paths in docs/install-paths.md
Inconsistencies
Missing pages
Polish
Found something not listed? Comment below or open an issue and link it here.
Related: #55, #61, #62.
Tracking issue for bringing the docs in line with the current repo. Each checkbox can become its own sub-issue. Comment to claim one.
Stale paths in
docs/install-paths.mdsources/core/tosources/rules/core/.agent/rulesto.agents/rulesand.codex/skills/to.agents/skills/src/codeguard-mcp/). Remove the sentence or link to MCP docs.Inconsistencies
docs/claude-code-skill-plugin.md— says "23 rules" in one place and "22" in another; the rules table is missingcodeguard-0-mcp-security. Fix to 23 and add the missing row.docs/getting-started.md:269—cd rulesshould becd project-codeguard.getting-started.mdandclaude-code-skill-plugin.md.opencode.jsonschema are still current./create-skillis not the preferred install path.Missing pages
docs/covering setup, IDE connection, and Docker; add it to the mkdocs nav.codeguard-reviewersubagent — add a page covering which hosts support it, how to invoke it, and the SARIF output.sources/skills/security-review,sources/skills/memory-safe-migration) — add a page explaining what each does.Polish
content.action.edittotheme.featuresinmkdocs.yml.Found something not listed? Comment below or open an issue and link it here.
Related: #55, #61, #62.