event-doc-generator

Community

Auto-generates Spring Boot event docs.

AuthorElliotChen
Version1.0.0
Installs0

System Documentation

What problem does it solve?

The Event Documentation Generator automates the creation of comprehensive event documentation for Spring Boot projects by scanning source code to identify events, publishers, and listeners, and then generating per-event Markdown files, catalogs, and diagrams.

Core Features & Use Cases

  • Auto-scans Java sources to detect Event types, Publishers, and Listeners
  • Generates per-event Markdown docs with field details, usage notes, and context mapping
  • Produces an index/catalog and Mermaid diagrams to visualize event flows
  • Supports DDD, Event Sourcing, and Event-Driven architectures for clear documentation

Quick Start

Run the generator from the repository root to scan your codebase and output documentation under docs/event.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: event-doc-generator
Download link: https://github.com/ElliotChen/ClaudeCode/archive/main.zip#event-doc-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.