From 00bbe4c6eaed7f055f89cc96f46fa79fa49d18fb Mon Sep 17 00:00:00 2001 From: Luong NGUYEN Date: Fri, 13 Mar 2026 05:19:37 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20Phase=205=20QA=20=E2=80=94=20fix=20cons?= =?UTF-8?q?istency,=20URLs,=20and=20terminology=20across=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Validated 170+ internal links, 52 external URLs, 40+ Mermaid diagrams, and cross-file consistency. Fixed redirecting slash-commands URL, normalized Mermaid color hex, standardized "subagents" terminology in CATALOG.md, and added CLAUDE.local.md legacy caveat. --- 02-memory/README.md | 2 +- 04-subagents/README.md | 2 +- CATALOG.md | 18 +++++++++--------- update-plan.md | 37 +++++++++++++++++++++---------------- 4 files changed, 32 insertions(+), 27 deletions(-) diff --git a/02-memory/README.md b/02-memory/README.md index 083c94d..c1b8ae7 100644 --- a/02-memory/README.md +++ b/02-memory/README.md @@ -1066,7 +1066,7 @@ Claude will prompt you to choose which memory file to update. For the most up-to-date information, refer to the official Claude Code documentation: - **[Memory Documentation](https://code.claude.com/docs/en/memory)** - Complete memory system reference -- **[Slash Commands Reference](https://code.claude.com/docs/en/slash-commands)** - All built-in commands including `/init` and `/memory` +- **[Slash Commands Reference](https://code.claude.com/docs/en/interactive-mode)** - All built-in commands including `/init` and `/memory` - **[CLI Reference](https://code.claude.com/docs/en/cli-reference)** - Command-line interface documentation ### Key Technical Details from Official Docs diff --git a/04-subagents/README.md b/04-subagents/README.md index 764ab4a..7645976 100644 --- a/04-subagents/README.md +++ b/04-subagents/README.md @@ -734,7 +734,7 @@ graph TB C -->|Results only| A D -->|Results only| A - style A fill:#e1f5ff + style A fill:#e1f5fe style B fill:#fff9c4 style C fill:#fff9c4 style D fill:#fff9c4 diff --git a/CATALOG.md b/CATALOG.md index 87d9ea0..97b46fd 100644 --- a/CATALOG.md +++ b/CATALOG.md @@ -7,7 +7,7 @@ > Quick reference guide to all Claude Code features: commands, agents, skills, plugins, and hooks. -**Navigation**: [Commands](#slash-commands) | [Sub-Agents](#sub-agents) | [Skills](#skills) | [Plugins](#plugins) | [MCP Servers](#mcp-servers) | [Hooks](#hooks) | [Memory](#memory-files) | [New Features](#new-features-march-2026) +**Navigation**: [Commands](#slash-commands) | [Subagents](#subagents) | [Skills](#skills) | [Plugins](#plugins) | [MCP Servers](#mcp-servers) | [Hooks](#hooks) | [Memory](#memory-files) | [New Features](#new-features-march-2026) --- @@ -16,7 +16,7 @@ | Feature | Built-in | Examples | Total | Reference | |---------|----------|----------|-------|-----------| | **Slash Commands** | 55 | 8 | 63 | [01-slash-commands/](01-slash-commands/) | -| **Sub-Agents** | 6 | 10 | 16 | [04-subagents/](04-subagents/) | +| **Subagents** | 6 | 10 | 16 | [04-subagents/](04-subagents/) | | **Skills** | 5 bundled | 4 | 9 | [03-skills/](03-skills/) | | **Plugins** | - | 3 | 3 | [07-plugins/](07-plugins/) | | **MCP Servers** | 1 | 8 | 9 | [05-mcp/](05-mcp/) | @@ -111,11 +111,11 @@ cp 01-slash-commands/*.md .claude/commands/ --- -## Sub-Agents +## Subagents Specialized AI assistants with isolated contexts for specific tasks. -### Built-in Sub-Agents +### Built-in Subagents | Agent | Description | Tools | Model | When to Use | |-------|-------------|-------|-------|-------------| @@ -126,7 +126,7 @@ Specialized AI assistants with isolated contexts for specific tasks. | **statusline-setup** | Status line configuration | Bash, Read, Write | Sonnet 4.6 | Configure status line display | | **Claude Code Guide** | Help and documentation | Read, Glob, Grep | Haiku 4.5 | Getting help, learning features | -### Custom Sub-Agents (Examples) +### Custom Subagents (Examples) | Agent | Description | When to Use | Scope | Installation | |-------|-------------|-------------|-------|--------------| @@ -215,7 +215,7 @@ Bundled collections of commands, agents, MCP servers, and hooks. .claude-plugin/ ├── plugin.json # Manifest file ├── commands/ # Slash commands -├── agents/ # Sub-agents +├── agents/ # Subagents ├── skills/ # Skills ├── mcp/ # MCP configurations ├── hooks/ # Hook scripts @@ -363,7 +363,7 @@ Persistent context loaded automatically across sessions. | **Project Rules** | `.claude/rules/` | Project (team) | Modular project rules | | **User** | `~/.claude/CLAUDE.md` | User (personal) | Personal preferences | | **User Rules** | `~/.claude/rules/` | User (personal) | Modular personal rules | -| **Local** | `./CLAUDE.local.md` | Local (git-ignored) | Machine-specific overrides | +| **Local** | `./CLAUDE.local.md` | Local (git-ignored) | Machine-specific overrides (not in official docs as of March 2026; may be legacy) | | **Auto Memory** | Automatic | Session | Auto-captured insights and corrections | > **Scope**: `Organization` = managed by admins, `Project` = shared with team via git, `User` = personal preferences, `Local` = not committed, `Session` = auto-managed @@ -407,7 +407,7 @@ cp 02-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md | Quick shortcut | Slash Command | Manual, immediate | | Persistent context | Memory | Auto-loaded | | Complex automation | Skill | Auto-invoked | -| Specialized task | Sub-Agent | Isolated context | +| Specialized task | Subagent | Isolated context | | External data | MCP Server | Real-time access | | Event automation | Hook | Event-triggered | | Complete solution | Plugin | All-in-one bundle | @@ -418,7 +418,7 @@ cp 02-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md |----------|---------|---------| | 1. Essential | Memory | `cp 02-memory/project-CLAUDE.md ./CLAUDE.md` | | 2. Daily Use | Slash Commands | `cp 01-slash-commands/*.md .claude/commands/` | -| 3. Quality | Sub-Agents | `cp 04-subagents/*.md .claude/agents/` | +| 3. Quality | Subagents | `cp 04-subagents/*.md .claude/agents/` | | 4. Automation | Hooks | `cp 06-hooks/*.sh ~/.claude/hooks/ && chmod +x ~/.claude/hooks/*.sh` | | 5. External | MCP | `claude mcp add github -- npx -y @modelcontextprotocol/server-github` | | 6. Advanced | Skills | `cp -r 03-skills/* ~/.claude/skills/` | diff --git a/update-plan.md b/update-plan.md index e37f17e..d6c7509 100644 --- a/update-plan.md +++ b/update-plan.md @@ -204,29 +204,34 @@ After Phases 1-3, these reference documents need updates to reflect all changes. --- -## Phase 5: Validation (Quality Assurance) +## Phase 5: Validation (Quality Assurance) ✅ COMPLETED -### Task 5.1: Link validation +> **Completed**: 2026-03-13 -- Check all internal cross-references between files -- Verify all external URLs (official docs, GitHub, etc.) -- Fix any broken anchor links +### Task 5.1: Link validation ✅ -### Task 5.2: Mermaid diagram review +- **Internal links**: 170+ links checked across 193 files — all valid (2 template placeholders in `finding-template.md` and `claude_concepts_guide.md` are intentional) +- **External URLs**: 52 unique URLs verified — all working +- **Fix applied**: Updated `code.claude.com/docs/en/slash-commands` → `/interactive-mode` in `02-memory/README.md` (old URL redirects to skills page) -- Verify all Mermaid diagrams still render correctly -- Update any diagrams that reference outdated features/flows +### Task 5.2: Mermaid diagram review ✅ -### Task 5.3: Conflict marker cleanup +- **40+ diagrams reviewed** across 13 files — all syntactically valid +- **Fix applied**: Normalized color hex `#e1f5ff` → `#e1f5fe` in `04-subagents/README.md` line 737 -- Review and resolve all `` markers -- Get user confirmation on ambiguous items +### Task 5.3: Conflict marker cleanup ✅ -### Task 5.4: Consistency check +- No `` markers found +- No git conflict markers (`<<<<<<<`, `=======`, `>>>>>>>`) found +- No leftover TODO/FIXME comments from docs sync process -- Ensure model names are consistent across all files -- Ensure command names match between tables and examples -- Ensure version numbers are consistent +### Task 5.4: Consistency check ✅ + +- **Model names**: All consistent (Sonnet 4.6, Opus 4.6, Haiku 4.5) — no outdated references +- **Terminology**: Standardized "Sub-Agents" → "subagents" in CATALOG.md (7 instances) +- **URLs**: All official doc URLs use `code.claude.com/docs/en/` consistently +- **CLAUDE.local.md**: Added legacy caveat to CATALOG.md to match 02-memory/README.md +- **Version numbers**: All consistent across files --- @@ -238,7 +243,7 @@ After Phases 1-3, these reference documents need updates to reflect all changes. | **Phase 2** | 10 tasks (2 skipped) | ✅ Completed 2026-03-13 | 6 files modified, 2 already complete | | **Phase 3** | 8 tasks | ✅ Completed 2026-03-13 | 3 files modified, ~612 net lines added | | **Phase 4** | 6 tasks | Required — cascade reference updates | Medium edits after Phases 1-3 | -| **Phase 5** | 4 tasks | Required — quality gate before merge | Automated + manual review | +| **Phase 5** | 4 tasks | ✅ Completed 2026-03-13 | 3 files modified, 10 fixes applied | **Total**: 36 tasks across 5 phases