Skip to content

Releases: trsoliu/mini-wiki

v3.1.0: Project Modernization

02 May 12:09
e990e8b

Choose a tag to compare

🏗️ Project Modernization

Major infrastructure upgrade bringing Mini-Wiki to 2026 Python ecosystem standards.

Highlights

  • Modern Python Toolchain: pyproject.toml + Ruff + mypy + pre-commit hooks
  • CI/CD Pipeline: GitHub Actions with matrix testing (Python 3.10/3.11/3.12)
  • 150 Test Cases: 100% module coverage across all 8 core scripts
  • Code Quality: Import sorting, narrowed exceptions, proper type annotations

New Files

  • pyproject.toml — Project metadata, dependencies, tool configuration
  • .pre-commit-config.yaml — Automated code quality hooks
  • .github/workflows/ci.yml — CI/CD pipeline
  • tests/ — 8 test modules with shared fixtures (2,193 lines)

Code Quality Fixes

  • Sorted imports (isort convention) across all scripts
  • Replaced broad Exception with specific OSError
  • Fixed type annotations (Optional[T] pattern)
  • Removed debug print statements
  • Removed redundant internal imports

Statistics

  • 150 test cases
  • 2,193 lines of test code
  • 8/8 modules covered
  • 3 Python versions tested in CI

Full Changelog: v3.0.8...v3.1.0

v3.0.8

05 Feb 02:58

Choose a tag to compare

Security & packaging hardening:\n- Clarified instruction-only plugin model (no code/script execution by agents)\n- Removed CLI run examples from plugin docs; manual-only guidance\n- Updated plugin protocol wording to apply guidance\n- Removed TLS verification override in plugin manager\n- Removed bundled agent-skills-main plugin set\n- Cleaned plugin registry and repacked mini-wiki.skill

v3.0.7 - Tech Stack Analysis Upgrade

30 Jan 01:08

Choose a tag to compare

🔧 Tech Stack Analysis Upgrade

Major upgrade to project analysis capabilities:

1. Monorepo Support

  • Detection: Automatically identifies Monorepo structures
  • Tools: turborepo, lerna, pnpm-workspaces, npm-workspaces, yarn-workspaces
  • Structure: Smartly analyzes packages/ and apps/ directories

2. Deep Language Analysis

  • Rust: Parses Cargo.toml to detect frameworks (actix-web, axum, tokio, tauri, rocket)
  • Go: Parses go.mod to detect frameworks (gin, echo, fiber, gorm)
  • Python: Enhanced pyproject.toml support (identifies poetry, pdm, flit and frameworks like fastapi, django)
  • Node.js: Precise package manager detection (npm, yarn, pnpm, bun)

v3.0.6 - 动态质量标准

29 Jan 01:25

Choose a tag to compare

📐 动态质量标准

质量标准不再是固定数字,而是基于模块复杂度动态计算

核心理念

不同模块复杂度不同,固定标准不合理:

模块类型 源码行数 期望文档行数
核心模块 (agent-core) 2000 行 600+ 行
工具模块 (utils) 200 行 80+ 行
配置模块 (constants) 50 行 50+ 行

动态计算公式

指标 计算公式
文档行数 max(100, source_lines × 0.3 + exports × 20)
代码示例 max(2, exports × 0.5)
图表数量 max(1, ceil(files / 5))
章节数 6 + module_role_weight

适配因子

  • 项目类型: frontend / backend / fullstack / library / cli
  • 开发语言: TypeScript / Python / Go / Rust
  • 模块角色: core (+4) / util (+2) / config (+1)

质量评级

等级 说明
🟢 Excellent 超过期望值 20%+
🟡 Good 达到期望值
🟠 Acceptable 达到期望值 80%+
🔴 Needs Work 低于期望值 80%

📦 安装

npx skills add trsoliu/mini-wiki

v3.0.5 - 业务领域分层 + 深度文档

29 Jan 01:18

Choose a tag to compare

🏗️ 业务领域分层 + 深度文档

对标 Qoder 文档质量,三大核心改进。

1. 业务领域分层(非扁平 modules/)

wiki/
├── AI系统/
│   ├── Agent核心/
│   └── MCP协议/
├── 存储系统/
├── 编辑器/
└── 跨平台/

2. 文档深度强化

指标 v3.0.4 v3.0.5
最少行数 200 400
章节数 9 12
图表数 2 3
代码示例 3 5

3. 代码示例强化(目标受众:AI & 架构评审)

每个文档必须包含 5 类示例:

  • 基础用法
  • 完整配置
  • 错误处理
  • 高级用法
  • 跨模块集成

核心理念

业务分层 + 深度内容 + 丰富示例 = Qoder 级文档质量

📦 安装

npx skills add trsoliu/mini-wiki

v3.0.4 - 分批生成机制

29 Jan 01:09

Choose a tag to compare

📦 分批生成机制

解决一次性生成多文档导致质量稀释的问题。

问题分析

问题 原因
每个文档只有 50-100 行 AI 输出 Token 有限
缺少深度章节 35+ 模块平均分配 Token
图表/源码追溯缺失 内容被压缩

解决方案

改进 说明
批次大小 5 → 2-3 个模块/批次
质量门槛 ≥200 行、≥9 章节、≥2 图表
每批检查 自动运行 check_quality.py
未达标处理 重新生成或补充内容

核心理念

Token 有限 → 减少批次大小 → 最大化单文档质量

使用方式

# 生成 wiki(自动分批)
生成 wiki / generate wiki

# 继续下一批
继续 / continue

# 检查质量
python scripts/check_quality.py .mini-wiki --verbose

📦 安装

npx skills add trsoliu/mini-wiki

v3.0.3 - 文档质量检查系统

28 Jan 15:02

Choose a tag to compare

🔍 新增文档质量检查系统

自动化检查生成文档是否符合 v3.0.2+ 质量标准。

新增功能

  • scripts/check_quality.py:文档质量自动检查脚本
    • 检查行数 (≥200)、章节数 (≥9)、图表数 (≥2-3)
    • 检查 classDiagram、源码追溯、必需章节
    • 输出质量评估报告(Professional/Standard/Basic)
    • 支持 --verbose 详细报告和 --json 导出

使用方法

# 基本检查
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

质量等级

等级 说明
🟢 Professional 完全符合标准
🟡 Standard 基本合格,可优化
🔴 Basic 需要升级

📦 安装

npx skills add trsoliu/mini-wiki

v3.0.2 - 文档质量标准强化

28 Jan 14:54

Choose a tag to compare

🚀 文档质量标准强化

对比 Qoder 等竞品文档质量后,大幅强化文档生成标准:

新增强制要求

  • 🔴 源码追溯:每个章节末尾必须包含 Section sourcesDiagram sources 引用
  • 🔴 classDiagram 强制:每个核心类/接口必须生成详细类图(含属性+方法)
  • 🔴 模块文档结构:强制 9 个必需章节
    • 概述、核心功能、目录结构、使用示例
    • 最佳实践、性能优化、错误处理/调试
    • 依赖关系、相关文档
  • 🔴 最小行数要求:模块文档最少 200+ 行
  • 图表要求提升:从 1-2 个提升到 2-3 个/文档

预期效果

使用 v3.0.2 生成的文档将:

  • 每个章节有源码引用可追溯
  • 核心类有完整类图展示
  • 模块文档内容丰满(200+ 行)
  • 包含最佳实践、性能优化、调试指南

📦 安装

npx skills add trsoliu/mini-wiki

或下载下方 mini-wiki.skill 文件。

v3.0.1 - 文档改进

28 Jan 13:40

Choose a tag to compare

📝 文档改进

  • 更新说明:在 README 中添加更新方式(npx / git / .skill 文件)
  • 常见问题:新增 FAQ 章节
    • 更新 Mini-Wiki 会删除已有文档吗?(不会)
    • 如何升级旧版本生成的低质量文档?(命令和质量等级说明)
    • 升级时会保留自定义内容吗?(会,使用 <!-- user-content --> 标记)
    • 如何检查文档质量?(检查 wiki 质量 命令)
  • UI 修复:所有 <details> 折叠区域默认展开
  • 图标修复:修复多语言图标不显示问题

📦 安装

npx skills add trsoliu/mini-wiki

或下载下方 mini-wiki.skill 文件。

v3.0.0 - 专业级文档生成系统

28 Jan 13:43

Choose a tag to compare

🚀 重大版本:专业级文档生成

本版本全面升级文档生成质量标准,从基础文档提升至企业级专业文档。

✨ 新增功能

  • 📋 文档质量标准体系

    • 内容深度要求:完整上下文、详细说明、可运行示例
    • 结构要求:层级标题、表格、Mermaid 图表、交叉链接
    • 每个文档至少 1-2 个图表
  • 🔍 深度代码分析

    • 代码语义分析(不仅分析结构,还理解功能)
    • 提取函数目的、参数、返回值、副作用
    • 识别设计模式和数据流
  • 🚀 大型项目渐进式扫描

    • 触发条件:模块 > 10 / 文件 > 50 / 代码行 > 10,000
    • 批次划分 + 优先级排序 + 进度跟踪
    • 断点续传:继续生成 wiki 命令
  • 🔄 文档升级刷新机制

    • 版本检测:自动识别旧版本生成的文档
    • 质量评估:basic / standard / professional 三级标准
    • 命令:检查 wiki 质量, 升级 wiki, 刷新全部 wiki

🔌 插件增强

  • api-doc-enhancer: 深度语义分析、3 层示例生成、API 关系图谱
  • repo-analytics: 5 维分析、健康度评分、协作网络图
  • patent-generator: 基于资深专利代理人经验重写,7 步标准专利交底书流程

📦 安装

npx skills add trsoliu/mini-wiki