trsoliu/mini-wiki

Overview

This skill automatically generates a professional-grade, structured project Wiki into a .mini-wiki/ directory. It synthesizes documentation from code, design files, and images to produce linked, diagram-rich, enterprise-quality docs. The generator supports deep semantic code analysis, incremental updates, Mermaid diagrams, and a plugin system for customizable instruction hooks.

How this skill works

The tool analyzes repository metadata and source files to detect tech stack, entry points, and business domains, then maps modules into a hierarchical Wiki structure. For each module it performs deep code analysis (functions, classes, data flow, error handling) and produces traceable documentation with source links and Mermaid diagrams. It supports incremental generation by detecting changes, applies instruction-only plugin hooks, and writes outputs under .mini-wiki/wiki/ with caches and metadata for efficient updates.

When to use it

• When you ask to "generate wiki", "create docs", or "create documentation" for a repository
• When you need to rebuild or update existing project documentation incrementally
• When you want cross-linked, enterprise-grade docs with diagrams and source traceability
• When deep semantic analysis of code and architecture diagrams are required
• When you need extensible behavior via a plugin manifest without executing plugin code

Best practices

• Keep repository entry points and package manifests (package.json, requirements.txt) up to date to improve domain detection
• Enable only trusted plugins and ensure their PLUGIN.md contains text-only instructions; the system will not run plugin code
• Commit source files before generation so change detection and incremental updates work reliably
• Provide design files and representative examples to allow richer diagrams and usage scenarios
• Use progressive scanning for very large projects (modules >10 or lines >10k) to ensure full coverage

Example use cases

• Generate a full project home, architecture, module, and API docs for a fullstack codebase
• Incrementally update docs after a set of modules changed, preserving unchanged pages
• Produce classDiagram, sequenceDiagram, and dependency graphs for architecture reviews
• Create cross-linked domain-oriented Wiki structure for multi-package monorepos
• Apply plugin guidance (on_init, after_analyze, before_generate, after_generate) to tailor doc style and coverage