doc-generation

Generate wiki-style documentation from AST-aware structural analysis of codebases.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/liminal-ai/code-steward --skill doc-generation-liminal-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generation
Source: https://github.com/liminal-ai/code-steward/tree/main/.agents/skills/doc-generation
Command: npx skills add https://github.com/liminal-ai/code-steward --skill doc-generation-liminal-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate and update wiki-style documentation for codebases using AST-aware structural analysis. Use when the user wants to generate documentation, update stale documentation, create a documentation wiki, or assess documentation coverage for a repository.

Core Features & Use Cases

  • AST-aware: Generate documentation from structural analysis across languages.
  • Wiki-style output: Flat docs/wiki/ with Mermaid diagrams, cross-references, and a repository overview.
  • Phased handling: Warns for large repos and supports phased generation (core modules first).
  • Use Case: Create a documentation wiki for a large codebase to surface architecture and component relationships.

Quick Start

Run the doc-generation skill on your repository to generate wiki-style documentation under docs/wiki/.

Frequently Asked Questions about doc-generation

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

FAQPage Schema
How do I generate wiki documentation for a codebase?

To generate wiki documentation, you run the skill on your repository to perform AST-aware structural analysis and output a flat docs/wiki/ directory with Mermaid diagrams and cross-references.

Can I update stale documentation without regenerating the entire wiki?

Yes, you can update stale documentation by running the skill to apply AST-based structural analysis across your multi-language repository, refreshing the existing docs/wiki/ output with current component mappings.

Does AST-based documentation generation work for large repositories?

AST-based documentation generation works for large repositories by warning about size and supporting phased generation, allowing you to process and document core modules first before expanding.

What is the best way to visualize codebase architecture in a wiki?

The best way to visualize codebase architecture in a wiki is using AST-based clustering to map components, which automatically generates Mermaid diagrams and cross-references into a flat docs/wiki/ directory.

How do I assess documentation coverage for a multi-language repository?

You assess documentation coverage for a multi-language repository by running the skill to perform AST-aware structural analysis, evaluating existing documentation against the mapped codebase components.

What formats are included in the generated codebase wiki?

The generated codebase wiki includes a flat docs/wiki/ directory containing a repository overview, Mermaid diagrams, and cross-references produced from the AST-based structural analysis.