Skip to content

Documentation refresh (tracking) #63

Description

@thomas-bartlett

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

  • Lines 155, 182, 200, 267 — change sources/core/ to sources/rules/core/
  • Lines 62, 118, 127, 143, 389, 391, 410 — change .agent/rules to .agents/rules and .codex/skills/ to .agents/skills/
  • Lines 266-267 — says "CodeGuard does not currently ship an MCP server." It does (see 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 missing codeguard-0-mcp-security. Fix to 23 and add the missing row.
  • docs/getting-started.md:269cd rules should be cd project-codeguard.
  • Verify Claude Code install steps are consistent between getting-started.md and claude-code-skill-plugin.md.
  • Verify the OpenCode install path and opencode.json schema are still current.
  • Document how to create Cursor Skill to fetch the rule files #23 — closed as not planned; Cursor /create-skill is not the preferred install path.

Missing pages

  • MCP server — add a page under docs/ covering setup, IDE connection, and Docker; add it to the mkdocs nav.
  • codeguard-reviewer subagent — add a page covering which hosts support it, how to invoke it, and the SARIF output.
  • Authored skills (sources/skills/security-review, sources/skills/memory-safe-migration) — add a page explaining what each does.

Polish

  • Homepage doesn't say which release the docs match. Add a version indicator.
  • Enable the "Edit this page" link on every docs page — add content.action.edit to theme.features in mkdocs.yml.

Found something not listed? Comment below or open an issue and link it here.

Related: #55, #61, #62.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions