Generate professional-grade structured project Wiki to .mini-wiki/ directory.

核心原则：生成的文档必须 详细、结构化、有图表、相互关联，达到企业级技术文档标准。

CRITICAL: All generated documentation MUST meet these standards:

• Every topic must have complete context - no bare lists or skeleton content
• Descriptions must be detailed and specific - explain WHY and HOW
• Must include working code examples with expected output
• Must document edge cases, warnings, common pitfalls

• Use hierarchical headings (H2/H3/H4) for clear information architecture
• Important concepts in tables for quick reference
• Processes visualized with Mermaid diagrams
• Cross-links between related documents

Every section MUST include source references at the end:

**Section sources**
- [filename.ts](file://path/to/file.ts#L1-L50)
- [another.ts](file://path/to/another.ts#L20-L80)

**Diagram sources**
- [architecture.ts](file://src/architecture.ts#L1-L100)

Every module document MUST include these sections (minimum 400+ lines):

文档主要受众是 AI 和架构评审，代码示例必须：

1. 完整可运行：包含 import、初始化、调用、结果处理
2. 覆盖核心场景：至少 5 个示例
3. 包含注释说明：解释关键步骤
4. 展示边界情况：错误处理、边界条件

// ✅ 好的示例：完整、可运行、有注释
import { AgentClient } from '@editverse/agent-core';
import { z } from 'zod';

// 1. 初始化客户端
const agent = await AgentClient.create({
  provider: 'openai',
  model: 'gpt-4',
  apiKey: process.env.OPENAI_API_KEY,
});

// 2. 定义工具
const searchTool = {
  name: 'search',
  description: '搜索网络内容',
  parameters: z.object({
    query: z.string().describe('搜索关键词'),
  }),
  execute: async ({ query }) => {
    const results = await fetch(`/api/search?q=${query}`);
    return results.json();
  },
};

// 3. 执行对话（带工具调用）
const response = await agent.chat({
  messages: [{ role: 'user', content: '搜索 AI 最新进展' }],
  tools: [searchTool],
});

// 4. 处理结果
console.log(response.content);
// 输出: "根据搜索结果，AI 最新进展包括..."

每个模块必须包含的示例类型：

For every core class/interface, generate detailed classDiagram:

classDiagram
class ClassName {
  +property1 : Type
  +property2 : Type
  -privateField : Type
  +method1(param : Type) : ReturnType
  +method2() : void
}

• Every document must have "Related Documents" section
• Module docs link to: architecture position, API reference, dependencies
• API docs link to: parent module, usage examples, type definitions

按业务领域分层组织，而不是扁平的 modules/ 目录

.mini-wiki/
├── config.yaml
├── meta.json
├── cache/
├── wiki/
│   ├── index.md                    # 项目首页
│   ├── architecture.md             # 系统架构
│   ├── getting-started.md          # 快速开始
│   ├── doc-map.md                  # 文档关系图
│   │
│   ├── AI系统/                      # 业务领域 1
│   │   ├── _index.md               # 领域概述
│   │   ├── Agent核心/              # 子领域
│   │   │   ├── _index.md
│   │   │   ├── 客户端.md           # 400+ 行
│   │   │   └── 工具系统.md         # 400+ 行
│   │   ├── MCP协议/
│   │   │   ├── _index.md
│   │   │   └── 配置管理.md
│   │   └── 对话流程/
│   │       ├── 状态管理.md
│   │       └── 响应处理.md
│   │
│   ├── 存储系统/                    # 业务领域 2
│   │   ├── _index.md
│   │   ├── 状态管理/
│   │   │   └── Zustand.md
│   │   └── 持久化/
│   │       └── 存储适配.md
│   │
│   ├── 编辑器/                      # 业务领域 3
│   │   ├── _index.md
│   │   ├── 核心/
│   │   └── 扩展/
│   │
│   ├── 跨平台/                      # 业务领域 4
│   │   ├── _index.md
│   │   ├── Electron/
│   │   └── Web/
│   │
│   └── api/                        # API 参考
└── i18n/

分析代码后，自动识别业务领域：

# 自动识别的业务领域映射
domain_mapping:
  AI系统:
    keywords: [agent, ai, llm, chat, mcp, tool]
    packages: [agent-core, agent, mcp-core, agent-bridge]
  存储系统:
    keywords: [store, storage, persist, state]
    packages: [store, storage, electron-secure-storage]
  编辑器:
    keywords: [editor, tiptap, markdown, document]
    packages: [editor-core, markdown, docx2tiptap-core]
  跨平台:
    keywords: [electron, desktop, web, app]
    packages: [apps/*, browser-core, electron-*]
  组件库:
    keywords: [component, ui, shadcn]
    packages: [shadcn-ui, chat-ui, media-viewer]

CRITICAL: As an AI executing this skill, you MUST follow this protocol to activate installed plugins.

1. Load Registry: Read plugins/_registry.yaml to see enabled plugins.
2. Read Manifests: For each enabled plugin, read its PLUGIN.md to understand its Hooks and Instructions.
3. Execute Hooks:
   • Pre-Analysis: If plugin has on_init, follow its instructions before starting.
   • Post-Analysis: If plugin has after_analyze, apply its logic after analyzing structure.
   • Pre-Generation: If plugin has before_generate, modify your generation plan/prompts.
   • Post-Generation: If plugin has after_generate or on_export, execute those tasks after wiki creation.

Example: If api-doc-enhancer is enabled, you MUST read its PLUGIN.md and follow its specific rules for generating API docs.

Check if .mini-wiki/ exists:

• Not exists: Run scripts/init_wiki.py to create directory structure
• Exists: Read config.yaml and cache, perform incremental update

Check plugins/ directory for installed plugins:

1. Read plugins/_registry.yaml for enabled plugins
2. For each enabled plugin, read PLUGIN.md manifest
3. Register hooks: on_init, after_analyze, before_generate, after_generate

Run scripts/analyze_project.py or analyze manually:

1. Identify tech stack: Check package.json, requirements.txt, etc.
2. Find entry points: src/index.ts, main.py, etc.
3. Identify modules: Scan src/ directory structure
4. Find existing docs: README.md, CHANGELOG.md, etc.
5. Execute after_analyze hooks from plugins

Save structure to cache/structure.json.

IMPORTANT: For each module, you MUST read and analyze the actual source code:

1. Read source files: Use read_file tool to read key source files
2. Understand code semantics: Analyze what the code does, not just its structure
3. Extract detailed information:
   • Function purposes, parameters, return values, side effects
   • Class hierarchies and relationships
   • Data flow and state management
   • Error handling patterns
   • Design patterns used
4. Identify relationships: Module dependencies, call graphs, data flow

📖 See references/prompts.md → "代码深度分析" for the analysis prompt template

Run scripts/detect_changes.py to compare file checksums:

• New files → Generate docs
• Modified files → Update docs
• Deleted files → Mark obsolete

Execute before_generate hooks from plugins, then generate content following strict quality standards:

Must include:

• Project badges and one-liner description
• 2-3 paragraphs detailed introduction (not just bullet points)
• Architecture preview diagram (Mermaid flowchart)
• Documentation navigation table with audience
• Core features table with links to modules
• Quick start code example with expected output
• Project statistics table
• Module overview table with links

Must include:

• Executive summary (positioning, tech overview, architecture style)
• System architecture diagram (Mermaid flowchart TB with subgraphs)
• Tech stack table with version and selection rationale
• Module dependency diagram (Mermaid flowchart)
• Detailed module descriptions with responsibility and interfaces
• Data flow diagram (Mermaid sequenceDiagram)
• State management diagram (if applicable)
• Directory structure with explanations
• Design patterns and principles
• Extension guide

Each module doc must include (16 sections minimum):

1. Module overview (2-3 paragraphs, not 2-3 sentences)
2. Core value proposition
3. Architecture position diagram (highlight current module)
4. Feature table with related APIs
5. File structure with responsibility descriptions
6. Core workflow diagram (Mermaid flowchart)
7. State diagram (if applicable)
8. Public API overview table
9. Detailed API documentation (signature, params, returns, examples)
10. Type definitions with field tables
11. Quick start code
12. 3+ usage examples with scenarios
13. Best practices (do's and don'ts)
14. Design decisions and trade-offs
15. Dependency diagram
16. Related documents links

Each API doc must include:

• Module overview with import examples
• API overview table
• Type definitions with property tables
• For each function:
  • One-liner + detailed description (3+ sentences)
  • Function signature
  • Parameter table with constraints and defaults
  • Return value with possible cases
  • Exception table
  • 3 code examples (basic, advanced, error handling)
  • Warnings and tips
  • Related APIs
• For classes: class diagram, constructor, properties, methods
• Usage patterns (2-3 complete scenarios)
• FAQ section
• Related documents

Must include:

• Prerequisites table with version requirements
• Multiple installation methods
• Configuration file explanation
• Step-by-step first example
• Next steps table
• Common issues FAQ

Must include:

• Document relationship diagram (Mermaid flowchart)
• Reading path recommendations by role
• Complete document index
• Module dependency matrix

Execute after_generate hooks from plugins.

Add source links to code blocks:

### `functionName` [📄](file:///path/to/file.ts#L42)

• Write wiki files to .mini-wiki/wiki/
• Update cache/checksums.json
• Update meta.json timestamp

问题：大型项目时，AI 可能只生成少量文档而没有全面覆盖所有模块。

当项目满足以下任一条件时，必须使用渐进式扫描策略：

• 模块数量 > 10
• 源文件数量 > 50
• 代码行数 > 10,000

flowchart TB
    A[项目分析] --> B{模块数量 > 10?}
    B -->|是| C[启用渐进式扫描]
    B -->|否| D[标准扫描]
    C --> E[模块优先级排序]
    E --> F[批次划分]
    F --> G[逐批生成文档]
    G --> H{还有未处理模块?}
    H -->|是| I[保存进度]
    I --> J[提示用户继续]
    J --> G
    H -->|否| K[生成索引和关系图]

按以下维度计算优先级分数：

🔴 关键：每批最多 1-2 个模块，确保每个文档 400+ 行

batch_config:
  batch_size: 1              # 每批处理 1-2 个模块（确保深度）
  min_lines_per_doc: 400     # 每个文档最少 400 行
  min_code_examples: 5       # 每个文档最少 5 个代码示例
  pause_between_batches: true # 批次间暂停确认
  auto_continue: false        # 是否自动继续下一批

批次分配示例（按业务领域组织）:

在 cache/progress.json 中记录：

{
  "version": "2.0.0",
  "total_modules": 25,
  "completed_modules": ["core", "utils", "api"],
  "pending_modules": ["auth", "db", ...],
  "current_batch": 2,
  "last_updated": "2026-01-28T21:15:00Z",
  "quality_version": "professional-v2"
}

当用户说 "继续生成 wiki" 或 "continue wiki generation" 时：

1. 读取 cache/progress.json
2. 跳过已完成的模块
3. 从下一批次继续

生成每批后，必须验证质量：

# 检查本批生成的文档
python scripts/check_quality.py .mini-wiki --verbose

质量门槛：

每批次完成后，向用户报告：

✅ 第 2 批完成 (6/25 模块)

已生成:
- modules/store.md (245 行, Professional ✅)
- modules/editor-core.md (312 行, Professional ✅)

质量检查: 全部通过 ✅

待处理: 19 个模块
预计还需: 10 批次

👉 输入 "继续" 生成下一批
👉 输入 "检查质量" 运行质量检查
👉 输入 "重新生成 <模块名>" 重新生成特定模块

# .mini-wiki/config.yaml
progressive:
  enabled: auto               # auto / always / never
  batch_size: 1               # 每批模块数（1-2 确保深度）
  min_lines_per_doc: 400      # 每个文档最少行数
  min_code_examples: 5        # 每个文档最少代码示例数
  quality_check: true         # 每批后自动检查质量
  auto_continue: false        # 自动继续无需确认
  
# 业务领域分层配置
domain_hierarchy:
  enabled: true               # 启用业务领域分层
  auto_detect: true           # 自动识别业务领域
  language: zh                # 目录名语言 (zh/en)
  priority_weights:           # 自定义优先级权重
    entry_point: 5
    dependency_count: 4
    code_lines: 2
    has_docs: 3
    recent_modified: 1
  skip_modules:               # 跳过的模块
    - __tests__
    - examples

问题：升级 mini-wiki 后，之前生成的低质量文档需要刷新升级。

在 meta.json 中记录文档生成版本，并在每个文档页脚显示：

页脚格式: *由 [Mini-Wiki v{{ MINI_WIKI_VERSION }}](https://github.com/trsoliu/mini-wiki) 自动生成 | {{ GENERATED_AT }}*

{
  "generator_version": "3.0.5",  // 用于 {{ MINI_WIKI_VERSION }}
  "quality_standard": "professional-v2",
  "generated_at": "2026-01-28T21:15:00Z",
  "modules": {
    "core": {
      "version": "1.0.0",
      "quality": "basic",
      "sections": 6,
      "has_diagrams": false,
      "last_updated": "2026-01-20T10:00:00Z"
    }
  }
}

flowchart TB
    A[检测 .mini-wiki/] --> B{meta.json 存在?}
    B -->|否| C[全新生成]
    B -->|是| D[读取版本信息]
    D --> E{版本 < 2.0.0?}
    E -->|是| F[标记需要升级]
    E -->|否| G{quality != professional?}
    G -->|是| F
    G -->|否| H[增量更新]
    F --> I[生成升级计划]
    I --> J[提示用户确认]

适用于：版本差异大、文档质量差

用户命令: "刷新全部 wiki" / "refresh all wiki"

适用于：模块多、希望保留部分内容

用户命令: "升级 wiki" / "upgrade wiki"

适用于：只想升级特定模块

用户命令: "升级 core 模块文档" / "upgrade core module docs"

# 伪代码
for doc in existing_docs:
    score = evaluate_quality(doc)
    if score.sections < 10 or not score.has_diagrams:
        mark_for_upgrade(doc, priority=HIGH)
    elif score.sections < 13:
        mark_for_upgrade(doc, priority=MEDIUM)

📊 Wiki 升级评估报告

当前版本: 1.0.0 (basic)
目标版本: 2.0.0 (professional)

需要升级的文档:
┌─────────────────┬──────────┬────────┬─────────┬──────────┐
│ 文档            │ 当前章节 │ 目标   │ 缺少图表│ 优先级   │
├─────────────────┼──────────┼────────┼─────────┼──────────┤
│ modules/core.md │ 6        │ 16     │ 是      │ 🔴 高    │
│ modules/api.md  │ 8        │ 16     │ 是      │ 🔴 高    │
│ modules/utils.md│ 10       │ 16     │ 否      │ 🟡 中    │
│ architecture.md │ 5        │ 12     │ 是      │ 🔴 高    │
└─────────────────┴──────────┴────────┴─────────┴──────────┘

👉 输入 "确认升级" 开始，或 "跳过 <文档>" 排除特定文档

升级时保留：

• 用户手动添加的内容（通过 <!-- user-content --> 标记）
• 自定义配置
• 历史版本备份到 cache/backup/

🔄 正在升级 modules/core.md (1/8)

升级内容:
  ✅ 扩展模块概述 (2句 → 3段)
  ✅ 添加架构位置图
  ✅ 添加核心工作流图
  ✅ 扩展 API 文档 (添加3个示例)
  ✅ 添加最佳实践章节
  ✅ 添加设计决策章节
  ✅ 添加依赖关系图
  ✅ 添加相关文档链接

章节数: 6 → 16 ✅
图表数: 0 → 3 ✅

# .mini-wiki/config.yaml
upgrade:
  auto_detect: true           # 自动检测需要升级的文档
  backup_before_upgrade: true # 升级前备份
  preserve_user_content: true # 保留用户自定义内容
  user_content_marker: "<!-- user-content -->"
  upgrade_strategy: progressive  # all / progressive / selective
  min_quality: professional   # 最低质量要求

Installation Sources:

• Local: /path/to/plugin
• GitHub: owner/repo (e.g., trsoliu/mini-wiki-extras)
• Skills.sh: Any compatible skill repo
• URL: https://example.com/plugin.zip

Note: Generic skills (SKILL.md) will be automatically wrapped as plugins.

python scripts/plugin_manager.py list
python scripts/plugin_manager.py install owner/repo
python scripts/plugin_manager.py install ./my-plugin

See references/plugin-template.md for plugin format.

Plugins support hooks:

• on_init - Run on initialization
• after_analyze - Add analysis data
• before_generate - Modify prompts
• after_generate - Post-process output
• on_export - Convert formats

# 基本检查
python scripts/check_quality.py /path/to/.mini-wiki

# 详细报告
python scripts/check_quality.py /path/to/.mini-wiki --verbose

# 导出 JSON 报告
python scripts/check_quality.py /path/to/.mini-wiki --json report.json

检查项目:

• 行数 (≥200)
• 章节数 (≥9)
• 图表数 (≥2-3)
• classDiagram 类图
• 代码示例 (≥3)
• 源码追溯 (Section sources)
• 必需章节 (最佳实践、性能优化、错误处理)

质量等级:

See references/ directory for detailed templates and prompts:

• prompts.md: AI prompt templates for professional-grade content generation
  • 通用质量标准 (Universal quality standards)
  • 代码深度分析 (Deep code analysis)
  • 模块文档 (Module documentation - 16 sections)
  • 架构文档 (Architecture documentation)
  • API 文档 (API reference)
  • 首页 (Homepage)
  • 关系图谱 (Document relationship map)
• templates.md: Wiki page templates with Mermaid diagrams
  • 首页模板 (Homepage template)
  • 架构文档模板 (Architecture template)
  • 模块文档模板 (Module template - comprehensive)
  • API 参考模板 (API reference template)
  • 快速开始模板 (Getting started template)
  • 文档索引模板 (Doc map template)
  • 配置模板 (Config template)
• plugin-template.md: Plugin format

.mini-wiki/config.yaml format:

generation:
  language: zh              # zh / en / both
  detail_level: detailed    # minimal / standard / detailed
  include_diagrams: true    # Generate Mermaid diagrams
  include_examples: true    # Include code examples
  link_to_source: true      # Link to source files
  min_sections: 10          # Minimum sections per module doc

diagrams:
  architecture_style: flowchart TB
  dataflow_style: sequenceDiagram
  use_colors: true          # Color-code module types

linking:
  auto_cross_links: true    # Auto-generate cross references
  generate_doc_map: true    # Generate doc-map.md
  generate_dependency_graph: true

exclude:
  - node_modules
  - dist
  - "*.test.ts"