auto-wiki-generator

Generate and incrementally update Markdown wiki documentation from source code.

3|Updated Nov 11, 2025
One-click install
npx skills add https://github.com/xingranya/CervixDetectAI --skill auto-wiki-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: auto-wiki-generator
Source: https://github.com/xingranya/CervixDetectAI/tree/main/.agent/skills/auto-wiki-generator
Command: npx skills add https://github.com/xingranya/CervixDetectAI --skill auto-wiki-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires fs, path, and includes scripts (resource) and references (resource) and examples (resource) components.

What problem does it solve?

This Skill automates the tedious and time-consuming process of generating and updating project documentation, ensuring your documentation stays in sync with your code.

Core Features & Use Cases

  • Automatic Scanning: Recursively scans project directories to understand structure and identify code files.
  • Intelligent Change Detection: Detects file modifications within a specified lookback period (default 7 days).
  • Incremental Updates: Updates only the changed sections of existing documents, preserving other content.
  • Standardized Output: Generates Markdown documents with citations, Mermaid diagrams, code examples, and SQL queries, adhering to existing project styles.
  • Use Case: After pushing new code for an API endpoint, simply run "update wiki" and the Skill will automatically update the API reference documentation with the new endpoint details and relevant code snippets.

Quick Start

Use the auto-wiki-generator skill to update the project wiki.

Frequently Asked Questions about auto-wiki-generator

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

FAQPage Schema
How do I automate project documentation generation from source code?

To automate project documentation generation, this Skill recursively scans your project directories, detects file changes within a lookback period, and generates standardized Markdown documents including structure, architecture, and API references.

How does incremental wiki updating work for Markdown documentation?

Incremental wiki updating detects modified files within a specified lookback period, defaulting to 7 days, and updates only the changed sections of existing Markdown documents while preserving other content.

Can I integrate automated wiki generation with a CI/CD pipeline?

Yes, you can integrate automated wiki generation with CI/CD pipelines. The Skill scans for code changes and generates Markdown documents with Mermaid diagrams and code citations during your pipeline execution.

What is the best way to keep database design documents in sync with code changes?

The best way to keep database design documents in sync is using automated scanning and incremental updates. The Skill generates Markdown documents with Mermaid diagrams and SQL query citations based on recent code modifications.

Does the documentation generator support custom Markdown templates?

Yes, the documentation generator supports custom templates. It adheres to existing project styles while generating standardized Markdown output with code examples, Mermaid diagrams, and SQL queries.