wiki-generator-lsp

Generate WIKI.md documentation from codebases using LSP-based analysis.

1|Updated Dec 28, 2025
One-click install
npx skills add https://github.com/s-celles/ai-config --skill wiki-generator-lsp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wiki-generator-lsp
Source: https://github.com/s-celles/ai-config/tree/main/ai/skills/wiki-generator-lsp
Command: npx skills add https://github.com/s-celles/ai-config --skill wiki-generator-lsp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Generates comprehensive WIKI.md documentation for codebases by leveraging Language Server Protocol (LSP) analysis to extract symbols, references, architecture diagrams, and data models.

Core Features & Use Cases

  • LSP-based symbol extraction: Detects classes, functions, interfaces, and modules across multiple languages.
  • Automated architecture and data modeling: Produces Mermaid diagrams for architecture, data flow, and ER/class diagrams.
  • Multi-language support: Works with TS/JS, Python, Go, Rust, Java, and C/C++ projects, with fallback analysis when LSP is unavailable.
  • Use Case: Generate a ready-to-publish WIKI.md for a new codebase to accelerate developer onboarding and knowledge transfer.

Quick Start

Run the generator on a codebase to produce a complete WIKI.md with diagrams and references.

Frequently Asked Questions about wiki-generator-lsp

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate WIKI.md documentation for my codebase?

You can auto-generate WIKI.md by running this tool, which analyzes source files using Language Server Protocol to extract symbols, references, and architecture diagrams. It outputs a structured WIKI.md with sections like Project Overview, Architecture, and API Reference.

What is LSP-based code analysis for generating architecture diagrams?

LSP-based code analysis uses the Language Server Protocol to detect classes, functions, interfaces, and modules across a codebase. This mechanism accurately extracts structural code information to automatically produce Mermaid diagrams for architecture, data flow, and data modeling.

Does this documentation generator work with Python, Go, Rust, and C/C++ projects?

Yes, the documentation generator supports multi-language projects including TS/JS, Python, Go, Rust, Java, and C/C++. It automatically detects the language and framework, analyzing source files with LSP when available.

Can I generate Mermaid architecture diagrams if my language lacks LSP support?

Yes, you can generate Mermaid architecture diagrams without a Language Server. The generator falls back to regex-based analysis to extract symbols and references when LSP is unavailable for your specific codebase.

What sections are included in an auto-generated WIKI.md for developer onboarding?

An auto-generated WIKI.md for developer onboarding includes structured sections such as Project Overview, Architecture, Project Structure, Core Components, Data Flow, Data Model, API Reference, Configuration, Getting Started, and Development Guide.