eventcatalog

You document event-driven architectures by packaging domain, service, and event knowledge into versionable Skill directories. Each Skill uses a root SKILL.md frontmatter for metadata anchoring and a rich MDX body to standardize discovery and operational guidance across teams.

Building an event catalog is done by running the EventCatalog generator to assemble and publish documentation from your resources. Each self-contained unit standardizes metadata for automated indexing, exposing domains, services, events, commands, and queries.

Yes, you can include custom scripts and diagrams when documenting event-driven systems. Each versionable Skill directory supports optional scripts/, references/, and assets/ folders that augment behavior and embed rich MDX-based instructions into the activation context.

MDX supports automated indexing for event-driven architecture discovery by anchoring metadata in a SKILL.md frontmatter. This exposes the Skill's id, name, and description, allowing automated systems to index and discover packaged domain and event knowledge efficiently.

A limitation of frontmatter-driven discovery is that each catalog entry requires a root SKILL.md file with mandatory name and description fields. Without this strict frontmatter structure, the automated indexing and discovery of your event-driven architecture components will not function.

Your event catalog needs versionable self-contained directories to scale complex event-driven architectures consistently. This structure packages domain and service knowledge as standalone units with optional resources, accelerating AI-assisted development and documentation workflows.