deepwiki

name	deepwiki
description	Analyze GitHub repos and auto-generate documentation with Mermaid architecture diagrams. Use when generating documentation for repos. Triggers on "/deepwiki", "生成文件", "repo documentation", "分析 repo".
allowed-tools	Bash, Read, Write, Grep, Glob, Task
version	1.0.0
scope	public
evolution	{"enabled":true,"version":"1.0.0","stability":"experimental","created":"2026-01-30T00:00:00.000Z"}

DeepWiki Skill

Analyze a GitHub repo and generate structured documentation with Mermaid architecture diagrams.

Syntax

/deepwiki <repo-url-or-name> [--output <location>]

Parameters

Parameter	Description	Example
repo	GitHub repo URL or org/name format	yei-finance/yei-lending
--output	Output location (optional)	notion, obsidian, ./path

Output Options

Option	Description
(default)	Display directly in conversation
--output notion	Write to Notion (will ask for page ID)
--output obsidian	Write to knowledge/repos/<repo>.md
--output <path>	Write to specified path

Examples

# Default: display in conversation
/deepwiki yei-finance/yei-lending

# Output to Notion
/deepwiki yei-finance/clovis --output notion

# Output to local file
/deepwiki yei-finance/pit --output ./docs/pit.md

# Output to Obsidian
/deepwiki yei-finance/yeiswap --output obsidian

---

Workflow

graph TD
    A[Input: repo URL/name] --> B[Clone or read repo]
    B --> C[Analyze directory structure]
    C --> D[Identify key files]
    D --> E[Read core source code]
    E --> F[Generate Wiki structure]
    F --> G[Generate Mermaid diagrams]
    G --> H{Output location?}
    H -->|default| I[Display in conversation]
    H -->|notion| J[Write to Notion]
    H -->|path| K[Write to local file]
    H -->|obsidian| L[Write to Obsidian]

---

Phase 1: Repo Analysis

1.1 Clone Repository

# Verify GitHub account
gh auth status

# Clone to temp directory
REPO_DIR="/tmp/deepwiki/<repo-name>"
gh repo clone <repo> "$REPO_DIR" -- --depth 1

# If already exists, pull latest
cd "$REPO_DIR" && git pull

1.2 Analyze Directory Structure

# Exclude common non-code directories
tree -L 3 -I 'node_modules|.git|dist|build|coverage|__pycache__|.next|target'

1.3 Identify Tech Stack

File	Tech Stack
package.json	Node.js/TypeScript
Cargo.toml	Rust
requirements.txt / pyproject.toml	Python
hardhat.config.js / hardhat.config.ts	Solidity + Hardhat
foundry.toml	Solidity + Foundry
Move.toml	Move
go.mod	Go

1.4 Identify Key Files

Priority reading order:

1. README.md - Existing documentation
2. package.json / Cargo.toml etc. - Dependencies and scripts
3. src/index.ts / src/lib.rs / src/main.py - Entry points
4. contracts/*.sol - Smart contracts
5. test/ - Test files (understand functionality)

---

Error Handling

Error	Detection	Action
Not authenticated	gh auth status fails	Run gh auth login, abort if fails
Repo not found (404)	gh repo clone exits non-zero	Inform user, verify org/name spelling
Private repo, no access	Clone fails with "Repository not found"	Ask user to confirm access or provide PAT via gh auth login --with-token
Clone directory exists	/tmp/deepwiki/<name> already present	git pull to update instead of re-clone
Clone failure (network/disk)	Non-zero exit, no files created	Report error message, suggest retry

Always run gh auth status before cloning. If any phase fails, report the exact error and stop — do not generate partial documentation.

---

Phase 2: Documentation Generation

Generate documentation using the following structure:

Output Structure

# <Repo Name>

> One-line description

## Tech Stack

- Framework: ...
- Language: ...
- Dependencies: ...

## Architecture Diagram

```mermaid
graph TD
    ...

Directory Structure

Folder	Purpose
src/	...
test/	...

Core Modules

Module A

• Function: ...
• Key API: ...

Module B

• ...

Quick Start

# Install
pnpm install

# Run
pnpm dev

Related Resources

• Original README
• Notion Documentation

---

## Phase 3: Mermaid Generation

Generate appropriate diagrams based on project type:

### Module Relationship Diagram (all projects)

```mermaid
graph TD
    A[Module A] --> B[Module B]
    B --> C[Library C]

Smart Contract Relationship Diagram (Solidity projects)

graph LR
    A[Contract A] -->|inherits| B[Contract B]
    A -->|calls| C[Library C]

Data Flow Diagram (if applicable)

sequenceDiagram
    User->>+Contract: deposit()
    Contract->>+Pool: addLiquidity()
    Pool-->>-Contract: lpTokens
    Contract-->>-User: receipt

---

Phase 4: Output

4.1 Default (display in conversation)

Output the generated markdown content directly.

4.2 Notion Output

# Ask user for page ID
# Write to temp file
echo "$CONTENT" > /tmp/deepwiki/output.md

# Update page using notion-cli
notion page update <page-id> --file /tmp/deepwiki/output.md

4.3 Local File Output

Use the Write tool to write to the specified path.

4.4 Obsidian Output

Write to knowledge/repos/<repo-name>.md.

---

Generation Quality Check

Ensure the generated documentation:

• Mermaid syntax is correct (renderable)
• Directory structure is accurate
• Tech stack identification is correct
• Core module descriptions are clear
• Quick start steps are executable

---

Integrations

• GitHub CLI (gh): Clone repos
• Notion CLI (notion): Write to Notion
• Write tool: Write to local/Obsidian

Verification

Post-generation verification:

1. Mermaid diagram syntax is correct
2. Links are valid
3. Steps are executable

Handoff

After completion, inform the user:

• Location of generated documentation
• How to view/edit
• Follow-up suggestions (if needed)