{"_id":"@amb007/deep-wiki","_rev":"2-842b82647a5abdd630c221f96e7b5ace","name":"@amb007/deep-wiki","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"@amb007/deep-wiki","version":"1.0.0","keywords":["pi","coding-agent","skill","documentation","wiki","vitepress","mermaid","pi-package"],"author":{"name":"Ported from Microsoft Skills"},"license":"MIT","_id":"@amb007/deep-wiki@1.0.0","maintainers":[{"name":"amb007","email":"a_bakic@yahoo.com"}],"homepage":"https://github.com/amb007/deep-wiki#readme","bugs":{"url":"https://github.com/microsoft/skills/issues"},"pi":{"skills":["SKILL.md"]},"dist":{"shasum":"c8ef494cbca8e2a73a1714a363b2110a0a034911","tarball":"https://registry.npmjs.org/@amb007/deep-wiki/-/deep-wiki-1.0.0.tgz","fileCount":23,"integrity":"sha512-oDZIH+yeIqKY1rCfaN4hxECioOpc5D24T+VHDAhgX5w3xS2HdR3+MNAW35OmIysw4skHkL9be+Jg9qab2C194Q==","signatures":[{"sig":"MEQCIEfr1a8JZuGTaTMpKpObH40UTeuwniISO3DeVE3Dps23AiAjYvTDuEfZtlaK2Id6DBnEIQP/i9Nmtm4P33m3dsRf1w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":124212},"main":"SKILL.md","gitHead":"42b1e1d611d8689e7636ee0fa796ec3beb250da1","_npmUser":{"name":"amb007","email":"a_bakic@yahoo.com"},"repository":{"url":"git+ssh://git@github.com/amb007/deep-wiki.git","type":"git"},"_npmVersion":"11.11.0","description":"AI-powered wiki generator for code repositories - Pi Coding Agent skill","directories":{},"_nodeVersion":"24.14.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/deep-wiki_1.0.0_1777226372364_0.545158901134916","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@amb007/deep-wiki","version":"2.0.0","description":"AI-powered wiki generator for code repositories - Pi Coding Agent skill","main":"SKILL.md","pi":{"skills":["SKILL.md"]},"keywords":["pi","coding-agent","skill","documentation","wiki","vitepress","mermaid","pi-package"],"author":{"name":"Ported from Microsoft Skills"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/amb007/deep-wiki.git"},"bugs":{"url":"https://github.com/microsoft/skills/issues"},"gitHead":"094c0f334908021a0ee4f0d6dfa63aa165a41699","_id":"@amb007/deep-wiki@2.0.0","homepage":"https://github.com/amb007/deep-wiki#readme","_nodeVersion":"24.14.1","_npmVersion":"11.11.0","dist":{"integrity":"sha512-5VmvrFvQUvesqC6FiTyeES6FX9FsoC/1FsEyiRGZWZErjse8Hfzk0NfqAZG+rt0oVzMevRxTIKJ5xHsmFj38jw==","shasum":"39d7d6d356ffe5408b9ffaeea8bf314018557b19","tarball":"https://registry.npmjs.org/@amb007/deep-wiki/-/deep-wiki-2.0.0.tgz","fileCount":24,"unpackedSize":167297,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDw8pOg42EeaGCvnJcmRsKEqiiguNtw9v49fwRB+Iy/VAIhAKNfb70W21iyQDYZ920WzDzfa8v7ZAdewgHS5W7Y41Nu"}]},"_npmUser":{"name":"amb007","email":"a_bakic@yahoo.com"},"directories":{},"maintainers":[{"name":"amb007","email":"a_bakic@yahoo.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/deep-wiki_2.0.0_1779741765900_0.49023121987248297"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-26T17:59:32.252Z","modified":"2026-05-25T20:42:46.153Z","1.0.0":"2026-04-26T17:59:32.503Z","2.0.0":"2026-05-25T20:42:46.047Z"},"bugs":{"url":"https://github.com/microsoft/skills/issues"},"author":{"name":"Ported from Microsoft Skills"},"license":"MIT","homepage":"https://github.com/amb007/deep-wiki#readme","keywords":["pi","coding-agent","skill","documentation","wiki","vitepress","mermaid","pi-package"],"repository":{"type":"git","url":"git+ssh://git@github.com/amb007/deep-wiki.git"},"description":"AI-powered wiki generator for code repositories - Pi Coding Agent skill","maintainers":[{"name":"amb007","email":"a_bakic@yahoo.com"}],"readme":"# 🌊 Deep Wiki\n\n**AI-Powered Wiki Generator for Code Repositories — Ported for Pi Coding Agent**\n\nGenerate comprehensive, structured, Mermaid-rich documentation wikis for any codebase — with dark-mode VitePress sites, onboarding guides, and deep research capabilities. Distilled from the prompt architectures of [OpenDeepWiki](https://github.com/AIDotNet/OpenDeepWiki) and [deepwiki-open](https://github.com/AsyncFuncAI/deepwiki-open).\n\n## Installation\n\nSee [INSTALL.md](./INSTALL.md) for installation instructions.\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `/skill:deep-wiki generate` | Generate a complete wiki — catalogue + all pages + onboarding guides + VitePress site |\n| `/skill:deep-wiki crisp` | Fast wiki generation — concise, parallelized, rate-limit-friendly. 5–8 pages, no build step |\n| `/skill:deep-wiki catalogue` | Generate only the hierarchical wiki structure as JSON |\n| `/skill:deep-wiki page <topic>` | Generate a single wiki page with dark-mode Mermaid diagrams |\n| `/skill:deep-wiki changelog` | Generate a structured changelog from git commits |\n| `/skill:deep-wiki research <topic>` | Multi-turn deep investigation with evidence-based analysis |\n| `/skill:deep-wiki ask <question>` | Ask a question about the repository |\n| `/skill:deep-wiki lookup <question>` | Look up answers in wiki first, update if needed |\n| `/skill:deep-wiki onboard` | Generate 4 audience-tailored onboarding guides (Contributor, Staff Engineer, Executive, PM) |\n| `/skill:deep-wiki agents` | Generate `AGENTS.md` files for pertinent folders (only where missing) |\n| `/skill:deep-wiki llms` | Generate `llms.txt` and `llms-full.txt` for LLM-friendly project access |\n| `/skill:deep-wiki ado` | Generate a Node.js script to convert wiki to Azure DevOps Wiki-compatible format |\n| `/skill:deep-wiki build` | Package generated wiki as a VitePress site with dark theme |\n| `/skill:deep-wiki deploy` | Generate GitHub Actions workflow to deploy wiki to GitHub Pages |\n\n## Agents\n\n| Agent | Description |\n|-------|-------------|\n| `wiki-architect` | Analyzes repos, generates structured catalogues + onboarding architecture |\n| `wiki-writer` | Generates pages with dark-mode Mermaid diagrams and deep citations |\n| `wiki-researcher` | Deep research with zero tolerance for shallow analysis — evidence-first |\n\n## Quick Start\n\n```bash\n# Generate a full wiki with onboarding guides and VitePress site\n/skill:deep-wiki generate\n\n# Fast wiki — concise, parallelized, avoids rate limits\n/skill:deep-wiki crisp\n\n# Just the structure\n/skill:deep-wiki catalogue\n\n# Single page with dark-mode diagrams\n/skill:deep-wiki page Authentication System\n\n# Generate onboarding guides\n/skill:deep-wiki onboard\n\n# Build VitePress dark-theme site\n/skill:deep-wiki build\n\n# Research a topic (evidence-based, 5 iterations)\n/skill:deep-wiki research How does the caching layer work?\n\n# Ask a question\n/skill:deep-wiki ask What database migrations exist?\n\n# Look up answers in wiki first\n/skill:deep-wiki lookup How does authentication work?\n\n# Generate llms.txt for LLM-friendly access\n/skill:deep-wiki llms\n\n# Deploy wiki to GitHub Pages (optional)\n/skill:deep-wiki deploy\n```\n\n## How It Works\n\n```\nRepository → Scan → Catalogue (JSON TOC) → Per-Section Pages → Assembled Wiki\n                                                    ↓\n                                         Mermaid Diagrams + Citations\n                                                    ↓\n                                         Onboarding Guides (Contributor, Staff Engineer, Executive, PM)\n                                                    ↓\n                                         VitePress Site (Dark Theme + Click-to-Zoom)\n                                                    ↓\n                                         AGENTS.md Files (Only If Missing)\n                                                    ↓\n                                         llms.txt + llms-full.txt (LLM-friendly)\n                                                    ↓\n                                         GitHub Pages Deployment (Optional)\n```\n\n| Step | Component | What It Does |\n|------|-----------|-------------|\n| 1 | `wiki-architect` | Analyzes repo → hierarchical JSON table of contents |\n| 2 | `wiki-page-writer` | For each TOC entry → rich Markdown with dark-mode Mermaid + citations |\n| 3 | `wiki-onboarding` | Generates 4 audience-tailored onboarding guides in `onboarding/` folder |\n| 4 | `wiki-vitepress` | Packages all pages into a VitePress dark-theme static site |\n| 5 | `wiki-changelog` | Git commits → categorized changelog |\n| 6 | `wiki-researcher` | Multi-turn investigation with evidence standard |\n| 7 | `wiki-qa` | Q&A grounded in actual source code |\n| 8 | `wiki-agents-md` | Generates `AGENTS.md` files for pertinent folders (only if missing) |\n| 9 | `wiki-llms-txt` | Generates `llms.txt` + `llms-full.txt` for LLM-friendly access |\n| 10 | `wiki-ado-convert` | Converts VitePress wiki to Azure DevOps Wiki-compatible format |\n\n## Design Principles\n\n1. **Source-linked citations**: Before any task, resolve the source repo URL (or confirm local). All citations use `[file:line](REPO_URL/blob/BRANCH/file#Lline)` for remote repos, `(file:line)` for local\n2. **Structure-first**: Always generate a TOC/catalogue before page content\n3. **Evidence-based**: Every claim cites `file_path:line_number` with clickable links — no hand-waving\n4. **Diagram-rich**: Minimum 3–5 dark-mode Mermaid diagrams per page using multiple diagram types, with click-to-zoom and `<!-- Sources: ... -->` comment blocks. More diagrams = better — use them liberally for architecture, flows, state, data models, and decisions.\n5. **Table-driven**: Prefer tables over prose for any structured information. Use summary tables, comparison tables, and always include a \"Source\" column with citations.\n6. **Progressive disclosure**: Big picture first, then drill into details. Every section starts with a TL;DR.\n7. **Hierarchical depth**: Max 4 levels for component-level granularity\n8. **Systems thinking**: Architecture → Subsystems → Components → Methods\n9. **Never invent**: All content derived from actual code — trace real implementations\n10. **Dark-mode native**: All output designed for dark-theme rendering (VitePress)\n11. **Depth before breadth**: Trace actual code paths, never guess from file names\n12. **Agent-discoverable**: Output placed at standard paths (`llms.txt` at repo root, `AGENTS.md` in key folders) so coding agents and MCP tools find documentation automatically\n\n## Style Modifiers\n\nDeep Wiki supports two special style modifiers that can be added to any command to adjust the tone, depth, and target audience of the generated documentation.\n\n### ELI-PhD (Explain Like I Have a PhD)\n\nWhen the user includes `ELI-PhD` or `explain like I have a PhD` in their query, the documentation is crafted for readers with PhD-level technical reasoning but who are unfamiliar with the specific domain.\n\n**Approach:**\n- Analogy-first, formalism-second: Use structural analogies before formal definitions\n- Concept hierarchy mapping: Explicitly state prerequisites, new concepts, and deferred topics\n- \"What problem does this solve?\" framing: Start with failure modes of naive approaches\n- Minimum viable mental model: Reconstruct the smallest derivable concept set\n- Two-level explanation: Shape summary → precise details\n- Historical/motivational narrative: Explain why the field converged on this approach\n- Worked examples before definitions: Concrete examples before abstract definitions\n\n**Usage:**\n```bash\n/skill:deep-wiki generate ELI-PhD\n/skill:deep-wiki research \"caching strategy\" ELI-PhD\n/skill:deep-wiki page \"Authentication Flow\" ELI-PhD\n```\n\n### ELIPC (Explain Like I'm a Potential Client)\n\nWhen the user includes `ELIPC` or `explain like I'm a potential client` in their query, the documentation is crafted for busy, skeptical technical decision-makers (evaluators, potential clients).\n\n**Approach:**\n- Lead with the villain (pain point), not the solution: Each page opens with specific pain points\n- \"So what\" ladder: Drill down to business impact\n- Movie trailer structure: Stakes → result → explanation\n- Name the enemy: \"Unlike X, this doesn't require Y\"\n- One-sentence positioning: \"For [who], this is the [what] that [does X], unlike [alternative]\"\n- Social proof: Put impressive numbers in headlines\n- Before/after demo: Show painful before vs. clean after\n- Reduce activation energy: One-line install, live playground, Colab\n\n**Usage:**\n```bash\n/skill:deep-wiki crisp ELIPC\n/skill:deep-wiki ask \"Why use this framework?\" ELIPC\n/skill:deep-wiki lookup \"authentication benefits\" ELIPC\n```\n\n### Supported Commands\n\nStyle modifiers are supported in the following commands:\n\n- `generate`\n- `crisp`\n- `page`\n- `research`\n- `ask`\n- `lookup`\n\nThey cannot be used with `catalogue`, `changelog`, `onboard`, `agents`, `llms`, `ado`, `build`, or `deploy` as those commands produce different output types not affected by style variations.\n\n## Agent & MCP Integration\n\nThe generated output is designed to be discoverable by coding agents using the Pi Coding Agent framework:\n\n| File | Path | Discovery Method |\n|------|------|-----------------|\n| `llms.txt` | Repo root (`./llms.txt`) | Standard llms.txt spec location — agents check here first via file reading\n| `llms-full.txt` | `wiki/llms-full.txt` | Full inlined docs — agents load this for comprehensive context\n| `AGENTS.md` | Root + key folders | Standard agent instructions file — references wiki docs in Documentation section\n| Wiki pages | `wiki/**/*.md` | Searchable via file search — all pages contain source-linked citations\n| `llms.txt` | `wiki/.vitepress/public/` | Served at `/llms.txt` on deployed VitePress site\n\n**How it works with Pi Coding Agent:**\n\n1. Agent reads `llms.txt` → gets project summary + links to all wiki pages\n2. Agent reads specific wiki pages → gets full documentation with source citations\n3. Agent searches for patterns → finds relevant wiki sections across the repository\n4. Agent reads `AGENTS.md` → Documentation section points to wiki and onboarding guides\n\n## Plugin Structure\n\n```\ndeep-wiki/\n├── agents/\n│   ├── wiki-architect.md\n│   ├── wiki-writer.md\n│   └── wiki-researcher.md\n├── commands/\n│   ├── generate.md\n│   ├── crisp.md\n│   ├── catalogue.md\n│   ├── page.md\n│   ├── changelog.md\n│   ├── research.md\n│   ├── ask.md\n│   ├── onboard.md\n│   ├── agents.md\n│   ├── llms.md\n│   ├── ado.md\n│   ├── build.md\n│   └── deploy.md\n└── README.md\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}