Synchronize all documentation under Docs/ with the actual codebase in 3 phases (update, consolidate, validate links).
Synchronize all documentation under ./Docs/ with the actual codebase. Work in 3 sequential phases.
For each subdirectory under ./Docs/, launch a general-purpose Agent to update the markdown files in that directory. Group agents in batches to stay within practical limits.
Batch 1 - Launch these agents in parallel (one agent per directory):
Docs/01-architecture/Docs/02-core-concepts/Docs/03-database-layer/Docs/04-service-layer/Docs/05-console-layer/Docs/06-configuration-reference/Docs/07-migration-files/Docs/08-cli-reference/Wait for Batch 1 to complete, then:
Batch 2 - Launch these agents in parallel:
Docs/09-extending/Docs/10-testing/Docs/12-config-wizard/Docs/appendix/Docs/examples/Docs/user-manual/Also update the top-level Docs/README.md in Batch 2.
Each agent receives this task:
Read every
.mdfile in your assigned directory. For each file:
- Identify all references to code files, classes, methods, configuration keys, CLI commands, enums, or interfaces.
- Find and read the referenced source code in the codebase to verify accuracy.
- Update the documentation so it matches the current code. This includes:
- Class/method/property names and signatures
- Configuration keys and their types/defaults
- Enum values and their numeric codes
- CLI command names, options, and descriptions
- Code examples and snippets
- File paths and project references
- Preserve the existing structure, tone, and formatting of each document.
- Do NOT modify any source code files - only update
.mdfiles underDocs/.- Remove dead documentation: If a documented class, method, enum, configuration key, CLI option, or feature no longer exists in the codebase, remove the corresponding section, table row, list item, or code example entirely. Do not leave stubs, "removed" notes, or placeholders. If removing a section leaves a parent section empty, remove the parent too.
- Document undocumented code: After verifying existing content, search the codebase for classes, methods, enums, configuration keys, CLI commands, and public APIs that fall within the scope of this document but are not yet documented. Add them in the appropriate location within the document, matching the existing style and level of detail. Scope is determined by the document's topic - e.g., a database-layer doc should cover all DAL classes, a CLI-reference doc should cover all registered commands.
After all Phase 1 agents complete, launch a single general-purpose Agent to:
Read ALL
.mdfiles under./Docs/. Check for:
- Contradictions: Same concept described differently in multiple files (e.g., different default values, conflicting enum names). Fix by aligning with the source code.
- Duplications: Identical content repeated across files. Consolidate into one authoritative location and cross-reference from others.
- Missing cross-references: Where one doc mentions a concept explained in detail elsewhere, add a
See [link](path)reference.- Consistency: Ensure terminology is uniform (e.g., always "target group" not sometimes "target-group" and sometimes "TargetGroup" in prose).
- If consolidation leaves a section empty or redundant, remove it.
- Only modify
.mdfiles underDocs/.
After Phase 2 completes, launch a single general-purpose Agent to:
Check ALL internal markdown links in files under
./Docs/:
- For every
[text](relative/path)link, verify the target file exists at that relative path.- For every
[text](path#anchor)link, verify both the file exists AND the anchor heading exists in the target file.- Check links in
CLAUDE.mdthat point toDocs/as well.- Fix any broken links:
- Correct the path if the file was moved/renamed
- Remove the entire link and surrounding sentence/item if the target no longer exists and the content is obsolete
- Fix anchor references to match actual heading text
- Only modify
.mdfiles.- Report a summary of all fixes made.
After all 3 phases complete, provide a summary to the user: