DeepWiki Parallel Wiki
Overview
Generate concise, cross-linked wiki pages directly from repository sources. Split discovery and drafting into parallel workstreams, then merge into a coherent, DeepWiki-style documentation set.
Workflow
-
Confirm scope and output path. Set the wiki root (for example
docs/wiki/) and confirm whether to overwrite existing pages. -
Build a repository map first. Inspect top-level directories, entrypoints, config files, and test directories before writing content.
-
Run parallel workstreams. Decompose documentation work into independent tracks and run them in parallel:
- Track A: Architecture and component boundaries
- Track B: Runtime/API/protocol flow
- Track C: Developer workflow (setup, test, release)
- Track D: Troubleshooting and FAQ
-
Merge into a single navigation tree. Create a top-level index page and ensure every page links back to the index.
-
Validate claims against sources. Each page must include a
Relevant source filessection listing exact paths used. -
Final quality gate. Remove speculation, de-duplicate overlapping sections, and verify command snippets.
Parallel Decomposition Rules
- Partition by topic, not by file, to reduce overlap.
- Keep each workstream's draft independent and source-cited.
- Prefer parallel reads for unrelated folders (backend/frontend/docs/tests).
- Merge only after all tracks have completed first drafts.
- Resolve conflicts in one pass: architecture terms, naming, and lifecycle sequence.
Required Output Structure
Create or update these pages unless the user requests a smaller set:
Overview.mdArchitecture.mdProtocol-and-Event-Flow.mdDeveloper-Workflow.mdTesting-and-Quality.mdTroubleshooting.mdREADME.md(wiki index)
For page format, use references/page-template.md.
DeepWiki Style Requirements
- Start each page with a short summary.
- Use explicit section headers and concise paragraphs.
- Include Mermaid diagrams for architecture or lifecycle-heavy pages.
- Add a
Relevant source filessection with concrete paths. - Prefer direct, verifiable statements over generalized advice.
- Keep onboarding pages operational: include runnable commands where needed.
Source-Grounded Citation Pattern
Use repository paths inline, for example:
claude-code-wrapper/src/claude_code_wrapper/runtime/kernel.pyweb/src/lib/wrapper-client.tsknowledges/USER_FLOWS.md
When unsure, mark as assumption and keep it out of authoritative sections.
Merge Checklist
- Navigation is complete and not circular.
- Terminology is consistent across pages.
- Commands are copy-paste ready.
- Runtime flow aligns with actual code paths.
- Every major claim maps to at least one source file.
Example User Prompts
- "Create a DeepWiki-style onboarding wiki for this monorepo."
- "Document architecture, runtime flow, and tests with source file references."
- "Generate a maintainer wiki from code, not assumptions."
Constraints
- Do not invent APIs, commands, or component names.
- Do not copy large external documentation blocks.
- Do not add extra docs outside requested wiki scope.
- Do not skip validation of commands when execution is available.
Resources
references/page-template.md: Standard page scaffold for DeepWiki-like docs.