# EventCatalog

> EventCatalog is an Open Source project that helps you document your messages, services and domains.

- [EventCatalog](/index.md)

## about-us

The story behind EventCatalog - an open source project built to bring discoverability to your architecture.

- [The Story Behind EventCatalog](/about-us.md): The story behind EventCatalog - an open source project built to bring discoverability to your architecture.

## blog

Blog

- [Blog  -  EventCatalog](/blog.md): Blog

### 2026

- [Introducing diagrams as first-class resources](/blog/2026/01/09/diagrams-as-first-class-resources.md): EventCatalog already gives you auto-generated visualizations: Entity Maps, Interaction Maps, and domain views that update as your catalog changes. These are great for understanding relationships between your resources.

### apicurio-registry-eventcatalog

Connect Apicurio Registry to EventCatalog for better schema governance and documentation

- [Integrate Apicurio Registry with EventCatalog](/blog/apicurio-registry-eventcatalog.md): Connect Apicurio Registry to EventCatalog for better schema governance and documentation

### architecture-change-detection

Architecture Change Detection in EventCatalog monitors your event-driven architecture across git branches and notifies your teams the moment a service starts or stops producing or consuming messages.

- [Your architecture is changing. Do you know about it?](/blog/architecture-change-detection.md): Architecture Change Detection in EventCatalog monitors your event-driven architecture across git branches and notifies your teams the moment a service starts or stops producing or consuming messages.

### archive

Archive

- [Archive](/blog/archive.md): Archive

### asyncapi-eventcatalog

Integrate your AsyncAPI files and auto your EventCatalog

- [AsyncAPI integration with EventCatalog](/blog/asyncapi-eventcatalog.md): Integrate your AsyncAPI files and auto your EventCatalog

### authentication-and-ssr-mode

Getting started with EventCatalog Authentication and SSR Mode

- [Introducing Authentication and SSR Mode](/blog/authentication-and-ssr-mode.md): Getting started with EventCatalog Authentication and SSR Mode

### azure-schema-registry-eventcatalog

Connect Azure Schema Registry to EventCatalog for better governance and documentation

- [Integrate Azure Schema Registry with EventCatalog](/blog/azure-schema-registry-eventcatalog.md): Connect Azure Schema Registry to EventCatalog for better governance and documentation

### built-in-mcp-server

Connect AI tools to your architecture with 15 tools and 9 resources

- [EventCatalog now includes a built-in MCP server](/blog/built-in-mcp-server.md): Connect AI tools to your architecture with 15 tools and 9 resources

### channels-20

Introducing EventCatalog 2.65.0 with support for channels 2.0

- [Modelling more message patterns in EventCatalog](/blog/channels-20.md): Introducing EventCatalog 2.65.0 with support for channels 2.0

### custom-icons

EventCatalog 3.28.1 lets you set a custom icon on any resource. One field in frontmatter and your visualiser goes from generic coloured boxes to a diagram that tells the real story of your stack.

- [Your catalog nodes now show what they actually are](/blog/custom-icons.md): EventCatalog 3.28.1 lets you set a custom icon on any resource. One field in frontmatter and your visualiser goes from generic coloured boxes to a diagram that tells the real story of your stack.

### custom-search-experience

EventCatalog introduces a completely redesigned search experience with advanced filtering, categorized results, and instant discovery for static builds. Find domains, services, events, and documentation faster than ever.

- [Introducing Search v2](/blog/custom-search-experience.md): EventCatalog introduces a completely redesigned search experience with advanced filtering, categorized results, and instant discovery for static builds. Find domains, services, events, and documentation faster than ever.

### data-products

Data products join EventCatalog as a first-class resource type with inputs, outputs, contracts, and full integration with your existing architecture.

- [Document, visualize and discover your data products](/blog/data-products.md): Data products join EventCatalog as a first-class resource type with inputs, outputs, contracts, and full integration with your existing architecture.

### documenting-sync-and-async-apis-with-eventcatalog

Learn how EventCatalog's OpenAPI and AsyncAPI generators help companies bridge the gap between synchronous REST APIs and asynchronous event-driven architectures

- [Documenting sync and async APIs with EventCatalog](/blog/documenting-sync-and-async-apis-with-eventcatalog.md): Learn how EventCatalog's OpenAPI and AsyncAPI generators help companies bridge the gap between synchronous REST APIs and asynchronous event-driven architectures

### domain-level-messages

Domain-level messaging gives teams more flexibility in how they model their event-driven architectures

- [Document events at the domain level](/blog/domain-level-messages.md): Domain-level messaging gives teams more flexibility in how they model their event-driven architectures

### eventbridge-eventcatalog

Integrate Amazon EventBridge with EventCatalog

- [Amazon EventBridge integration with EventCatalog](/blog/eventbridge-eventcatalog.md): Integrate Amazon EventBridge with EventCatalog

### eventcatalog-2130

Introducing EventCatalog 2.13.0 with support for channels

- [2.13.0](/blog/eventcatalog-2130.md): Introducing EventCatalog 2.13.0 with support for channels

### eventcatalog-250

Introducing EventCatalog 2.5.0 with support for flows

- [2.5.0](/blog/eventcatalog-250.md): Introducing EventCatalog 2.5.0 with support for flows

### eventcatalog-april-2025

EventCatalog updates for April 2025

- [Whats new in EventCatalog - April 2025](/blog/eventcatalog-april-2025.md): EventCatalog updates for April 2025

### eventcatalog-attachments

Link external resources, diagrams, and documentation to your EventCatalog resources

- [Introducing Attachments for EventCatalog](/blog/eventcatalog-attachments.md): Link external resources, diagrams, and documentation to your EventCatalog resources

### eventcatalog-august-2024

Overview of what was released in August 2024

- [EventCatalog August 2024 update](/blog/eventcatalog-august-2024.md): Overview of what was released in August 2024

### eventcatalog-august-2025

EventCatalog updates for August 2025

- [Whats new in EventCatalog - August 2025](/blog/eventcatalog-august-2025.md): EventCatalog updates for August 2025

### eventcatalog-changelogs

Understand and explore how to add changelogs to your domains, services and messages

- [Announcing Changelogs for EventCatalog](/blog/eventcatalog-changelogs.md): Understand and explore how to add changelogs to your domains, services and messages

### eventcatalog-chat

Understand your architecture through conversation

- [Introducing EventCatalog Chat](/blog/eventcatalog-chat.md): Understand your architecture through conversation

### eventcatalog-cli

The EventCatalog SDK now includes a command-line interface, making automation and integration dead simple

- [Access your EventCatalog from the command line](/blog/eventcatalog-cli.md): The EventCatalog SDK now includes a command-line interface, making automation and integration dead simple

### eventcatalog-cloud

EventCatalog Cloud is a new way to experience EventCatalog, and license for plugins.

- [Introducing EventCatalog Cloud and Plugin Licensing](/blog/eventcatalog-cloud.md): EventCatalog Cloud is a new way to experience EventCatalog, and license for plugins.

### eventcatalog-components

Understand how to create custom components for eventcatalog

- [Introducing Custom Components](/blog/eventcatalog-components.md): Understand how to create custom components for eventcatalog

### eventcatalog-custom-docs

Bring your own documentation to EventCatalog

- [Introducing EventCatalog Custom Documentation](/blog/eventcatalog-custom-docs.md): Bring your own documentation to EventCatalog

### eventcatalog-december-2024

EventCatalog updates for December 2024

- [EventCatalog December 2024 update](/blog/eventcatalog-december-2024.md): EventCatalog updates for December 2024

### eventcatalog-diagrams

Bring your diagrams to life with EventCatalog

- [Bring your diagrams to EventCatalog](/blog/eventcatalog-diagrams.md): Bring your diagrams to life with EventCatalog

### eventcatalog-directory

EventCatalog Directory is a new way to find users and teams using EventCatalog.

- [Introducing EventCatalog Directory](/blog/eventcatalog-directory.md): EventCatalog Directory is a new way to find users and teams using EventCatalog.

### eventcatalog-february-2025

EventCatalog updates for February 2025

- [EventCatalog February 2025 update](/blog/eventcatalog-february-2025.md): EventCatalog updates for February 2025

### eventcatalog-federation

Merge multiple EventCatalog instances into one for a single source of truth

- [Introducing EventCatalog Federation](/blog/eventcatalog-federation.md): Merge multiple EventCatalog instances into one for a single source of truth

### eventcatalog-icepanel

Visualize your C4 architecture diagrams with IcePanel integration

- [Embed IcePanel Diagrams in EventCatalog](/blog/eventcatalog-icepanel.md): Visualize your C4 architecture diagrams with IcePanel integration

### eventcatalog-january-2026

EventCatalog updates for January 2026

- [What's new in EventCatalog - January 2026](/blog/eventcatalog-january-2026.md): EventCatalog updates for January 2026

### eventcatalog-july-2025

EventCatalog updates for July 2025

- [Whats new in EventCatalog - July 2025](/blog/eventcatalog-july-2025.md): EventCatalog updates for July 2025

### eventcatalog-june-2025

EventCatalog updates for June 2025

- [Whats new in EventCatalog - June 2025](/blog/eventcatalog-june-2025.md): EventCatalog updates for June 2025

### eventcatalog-linter

Catch issues early and maintain high-quality documentation with the new EventCatalog Linter

- [Introducing the EventCatalog Linter](/blog/eventcatalog-linter.md): Catch issues early and maintain high-quality documentation with the new EventCatalog Linter

### eventcatalog-march-2025

EventCatalog updates for March 2025

- [EventCatalog March 2025 update](/blog/eventcatalog-march-2025.md): EventCatalog updates for March 2025

### eventcatalog-march-2026

EventCatalog updates for March 2026

- [Whats new in EventCatalog - March 2026](/blog/eventcatalog-march-2026.md): EventCatalog updates for March 2026

### eventcatalog-may-2025

EventCatalog updates for May 2025

- [Whats new in EventCatalog - May 2025](/blog/eventcatalog-may-2025.md): EventCatalog updates for May 2025

### eventcatalog-mcp

Connect your EventCatalog to any MCP Client (e.g Cursor, Windsurf, Claude Desktop)

- [Introducing EventCatalog MCP Server](/blog/eventcatalog-mcp.md): Connect your EventCatalog to any MCP Client (e.g Cursor, Windsurf, Claude Desktop)

### eventcatalog-miro

Bring your diagrams to life with Miro integration

- [Bring Your Miro Boards to Life in EventCatalog](/blog/eventcatalog-miro.md): Bring your diagrams to life with Miro integration

### eventcatalog-miro-app

The EventCatalog Miro App v2 turns your architecture documentation into interactive, collaborative design artifacts — and sends them back when you're done.

- [Your documentation is a design artifact, not just a wiki page](/blog/eventcatalog-miro-app.md): The EventCatalog Miro App v2 turns your architecture documentation into interactive, collaborative design artifacts — and sends them back when you're done.

### eventcatalog-november-2024

EventCatalog updates for November 2024

- [EventCatalog November 2024 update](/blog/eventcatalog-november-2024.md): EventCatalog updates for November 2024

### eventcatalog-october-2024

EventCatalog updates for October 2024

- [EventCatalog October 2024 update](/blog/eventcatalog-october-2024.md): EventCatalog updates for October 2024

### eventcatalog-october-2025

EventCatalog updates for October 2025

- [Whats new in EventCatalog - October 2025](/blog/eventcatalog-october-2025.md): EventCatalog updates for October 2025

### eventcatalog-openai

EventCatalog now integrates with OpenAI, allowing you to use OpenAI models in your documentation.

- [EventCatalog now integrates with OpenAI](/blog/eventcatalog-openai.md): EventCatalog now integrates with OpenAI, allowing you to use OpenAI models in your documentation.

### eventcatalog-sdk

Understand and explore the SDK for EventCatalog

- [Announcing the new EventCatalog SDK](/blog/eventcatalog-sdk.md): Understand and explore the SDK for EventCatalog

### eventcatalog-september-2024

Overview of what was released in September 2024

- [EventCatalog September 2024 update](/blog/eventcatalog-september-2024.md): Overview of what was released in September 2024

### eventcatalog-september-2025

EventCatalog updates for September 2025

- [Whats new in EventCatalog - September 2025](/blog/eventcatalog-september-2025.md): EventCatalog updates for September 2025

### eventcatalog-themes-dark-mode

Customize your catalog with built-in themes, dark mode support, and create your own custom themes

- [Introducing Themes and Dark Mode](/blog/eventcatalog-themes-dark-mode.md): Customize your catalog with built-in themes, dark mode support, and create your own custom themes

### eventcatalog-v2

Whats new in EventCatalog and how to get started

- [Introducing EventCatalog v2](/blog/eventcatalog-v2.md): Whats new in EventCatalog and how to get started

### eventcatalog-v3

What's new in EventCatalog v3 and how to get started

- [Introducing EventCatalog v3](/blog/eventcatalog-v3.md): What's new in EventCatalog v3 and how to get started

### external-systems

A new externalSystem flag lets you mark services like Stripe, Twilio, or Snowflake as third-party dependencies. They get their own colour, their own sidebar section, and their own tab in discover.

- [Model external systems in EventCatalog](/blog/external-systems.md): A new externalSystem flag lets you mark services like Stripe, Twilio, or Snowflake as third-party dependencies. They get their own colour, their own sidebar section, and their own tab in discover.

### field-usage

EventCatalog already shows you which services consume a message. Now it can also show you which specific fields they use.

- [Which fields are your consumers actually using?](/blog/field-usage.md): EventCatalog already shows you which services consume a message. Now it can also show you which specific fields they use.

### flow-wizard

The new flow-wizard skill lets you describe a business workflow in plain language while your AI agent builds the flow and wires it to your existing catalog resources.

- [Describe the workflow, let the agent build the flow](/blog/flow-wizard.md): The new flow-wizard skill lets you describe a business workflow in plain language while your AI agent builds the flow and wires it to your existing catalog resources.

### focus-mode

Navigate through your architecture by clicking nodes to see their inputs and outputs in a dedicated view

- [Click any node to explore its connections in Focus Mode](/blog/focus-mode.md): Navigate through your architecture by clicking nodes to see their inputs and outputs in a dedicated view

### github-actions

Getting started with EventCatalog GitHub Action

- [Introducing the EventCatalog GitHub Action](/blog/github-actions.md): Getting started with EventCatalog GitHub Action

### github-as-a-schema-registry

EventCatalog now supports GitHub as a schema registry, allowing you to document your schemas in GitHub and keep them in sync with your documentation.

- [Using GitHub as a schema registry with EventCatalog](/blog/github-as-a-schema-registry.md): EventCatalog now supports GitHub as a schema registry, allowing you to document your schemas in GitHub and keep them in sync with your documentation.

### graphql-eventcatalog

Integrate your GraphQL schema files and automate your EventCatalog

- [Introducing GraphQL integration with EventCatalog](/blog/graphql-eventcatalog.md): Integrate your GraphQL schema files and automate your EventCatalog

### introducing-data-resources

Document your data stores in EventCatalog

- [Introducing Data Stores with EventCatalog](/blog/introducing-data-resources.md): Document your data stores in EventCatalog

### introducing-entity-maps

Visualize and explore entity relationships within your domains with EventCatalog's new Entity Maps feature

- [Introducing Entity Maps](/blog/introducing-entity-maps.md): Visualize and explore entity relationships within your domains with EventCatalog's new Entity Maps feature

### introducing-eventcatalog-reports

EventCatalog now includes Governance Reports, helping you measure and track your architecture’s health.

- [Introducing EventCatalog Reports](/blog/introducing-eventcatalog-reports.md): EventCatalog now includes Governance Reports, helping you measure and track your architecture’s health.

### introducing-queries

Introducing queries for EventCatalog

- [Introducing query messages for EventCatalog](/blog/introducing-queries.md): Introducing queries for EventCatalog

### live-data-meets-architecture-documentation

Extend EventCatalog Assistant with custom tools to bring real-time metrics, service health, on-call information, and more into your architecture conversations

- [Live data meets architecture documentation](/blog/live-data-meets-architecture-documentation.md): Extend EventCatalog Assistant with custom tools to bring real-time metrics, service health, on-call information, and more into your architecture conversations

### message-usage-examples

Message Usage Examples lets you ship real payload samples alongside your events, commands, and queries so your team never has to guess what an OrderCreated event actually looks like in production.

- [Document examples with your schemas](/blog/message-usage-examples.md): Message Usage Examples lets you ship real payload samples alongside your events, commands, and queries so your team never has to guess what an OrderCreated event actually looks like in production.

### openapi-consumer-services

The EventCatalog OpenAPI generator now lets you define consumer services with optional route-based filtering, so you can document the full producer-consumer picture directly from your OpenAPI specs.

- [Document who consumes your APIs, not just who owns them](/blog/openapi-consumer-services.md): The EventCatalog OpenAPI generator now lets you define consumer services with optional route-based filtering, so you can document the full producer-consumer picture directly from your OpenAPI specs.

### openapi-eventcatalog

Integrate your OpenAPI files and auto your EventCatalog

- [OpenAPI integration with EventCatalog](/blog/openapi-eventcatalog.md): Integrate your OpenAPI files and auto your EventCatalog

### remote-schema-component

EventCatalog 2.52.0 introduces the RemoteSchema component, enabling real-time schema synchronization from external APIs and keeping your documentation always up-to-date.

- [Introducing Remote Schemas - Fetch and Sync Schemas at Runtime](/blog/remote-schema-component.md): EventCatalog 2.52.0 introduces the RemoteSchema component, enabling real-time schema synchronization from external APIs and keeping your documentation always up-to-date.

### resource-docs

Stop losing documentation in wikis and Confluence pages. Resource-level documentation lets you attach runbooks, ADRs, guides, and more directly to the services, events, and domains they describe.

- [The right documentation, in the right place](/blog/resource-docs.md): Stop losing documentation in wikis and Confluence pages. Resource-level documentation lets you attach runbooks, ADRs, guides, and more directly to the services, events, and domains they describe.

### schema-features

EventCatalog Schema updates

- [EventCatalog 2.64.0 - Schemas!](/blog/schema-features.md): EventCatalog Schema updates

### schema-fields-explorer

EventCatalog now indexes every field from every message schema and lets you search, filter, and trace fields across your entire architecture. Scale plan users get Field Intelligence with type conflict detection and interactive traceability graphs.

- [Trace every field across your schemas and architecture](/blog/schema-fields-explorer.md): EventCatalog now indexes every field from every message schema and lets you search, filter, and trace fields across your entire architecture. Scale plan users get Field Intelligence with type conflict detection and interactive traceability graphs.

### slack-integration

Stop searching through wikis and Confluence pages. Get architecture answers where your team already works.

- [EventCatalog Slack integration](/blog/slack-integration.md): Stop searching through wikis and Confluence pages. Get architecture answers where your team already works.

### tags

- [Tags](/blog/tags.md)
- [One post tagged with "2"](/blog/tags/2.md)
- [6 posts tagged with "AI"](/blog/tags/ai.md)
- [One post tagged with "API Documentation"](/blog/tags/api-documentation.md)
- [One post tagged with "API Integration"](/blog/tags/api-integration.md)
- [One post tagged with "Apicurio"](/blog/tags/apicurio.md)
- [3 posts tagged with "Architecture"](/blog/tags/architecture.md)
- [One post tagged with "Assistant"](/blog/tags/assistant.md)
- [2 posts tagged with "AsyncAPI"](/blog/tags/async-api.md)
- [One post tagged with "Attachments"](/blog/tags/attachments.md)
- [One post tagged with "August"](/blog/tags/august.md)
- [One post tagged with "Authentication"](/blog/tags/authentication.md)
- [One post tagged with "Automation"](/blog/tags/automation.md)
- [One post tagged with "Azure"](/blog/tags/azure.md)
- [One post tagged with "C4"](/blog/tags/c-4.md)
- [One post tagged with "Change Detection"](/blog/tags/change-detection.md)
- [One post tagged with "Changelogs"](/blog/tags/changelogs.md)
- [2 posts tagged with "Channels"](/blog/tags/channels.md)
- [One post tagged with "CI/CD"](/blog/tags/ci-cd.md)
- [One post tagged with "CLI"](/blog/tags/cli.md)
- [One post tagged with "commands"](/blog/tags/commands.md)
- [3 posts tagged with "Component"](/blog/tags/component.md)
- [One post tagged with "Components"](/blog/tags/components.md)
- [One post tagged with "Custom Tools"](/blog/tags/custom-tools.md)
- [One post tagged with "Customization"](/blog/tags/customization.md)
- [2 posts tagged with "Dark Mode"](/blog/tags/dark-mode.md)
- [One post tagged with "Data"](/blog/tags/data.md)
- [One post tagged with "Data Products"](/blog/tags/data-products.md)
- [One post tagged with "DDD"](/blog/tags/ddd.md)
- [One post tagged with "Design"](/blog/tags/design.md)
- [One post tagged with "diagrams"](/blog/tags/diagrams.md)
- [One post tagged with "Distributed System"](/blog/tags/distributed-system.md)
- [3 posts tagged with "Documentation"](/blog/tags/documentation.md)
- [One post tagged with "Domain-Driven Design"](/blog/tags/domain-driven-design.md)
- [One post tagged with "domains"](/blog/tags/domains.md)
- [One post tagged with "Draw.io"](/blog/tags/draw-io.md)
- [One post tagged with "EDA"](/blog/tags/eda.md)
- [One post tagged with "Entity Maps"](/blog/tags/entity-maps.md)
- [One post tagged with "EventBridge"](/blog/tags/event-bridge.md)
- [73 posts tagged with "EventCatalog"](/blog/tags/event-catalog.md)
- [One post tagged with "Event-Driven Architecture"](/blog/tags/event-driven-architecture.md)
- [One post tagged with "Event Hubs"](/blog/tags/event-hubs.md)
- [3 posts tagged with "Events"](/blog/tags/events.md)
- [One post tagged with "Examples"](/blog/tags/examples.md)
- [One post tagged with "Features"](/blog/tags/features.md)
- [One post tagged with "Field Intelligence"](/blog/tags/field-intelligence.md)
- [One post tagged with "Field Usage"](/blog/tags/field-usage.md)
- [2 posts tagged with "Flows"](/blog/tags/flows.md)
- [One post tagged with "Focus Mode"](/blog/tags/focus-mode.md)
- [One post tagged with "Generators"](/blog/tags/generators.md)
- [2 posts tagged with "Governance"](/blog/tags/governance.md)
- [One post tagged with "GraphQL"](/blog/tags/graph-ql.md)
- [One post tagged with "IcePanel"](/blog/tags/ice-panel.md)
- [One post tagged with "Icons"](/blog/tags/icons.md)
- [One post tagged with "Integration"](/blog/tags/integration.md)
- [One post tagged with "Integrations"](/blog/tags/integrations.md)
- [One post tagged with "January"](/blog/tags/january.md)
- [One post tagged with "July"](/blog/tags/july.md)
- [One post tagged with "June"](/blog/tags/june.md)
- [2 posts tagged with "Layout"](/blog/tags/layout.md)
- [One post tagged with "Linter"](/blog/tags/linter.md)
- [One post tagged with "Lucid"](/blog/tags/lucid.md)
- [One post tagged with "March"](/blog/tags/march.md)
- [One post tagged with "MCP"](/blog/tags/mcp.md)
- [2 posts tagged with "Messages"](/blog/tags/messages.md)
- [3 posts tagged with "Miro"](/blog/tags/miro.md)
- [One post tagged with "October"](/blog/tags/october.md)
- [One post tagged with "OpenAI"](/blog/tags/open-ai.md)
- [3 posts tagged with "OpenAPI"](/blog/tags/open-api.md)
- [One post tagged with "Quality"](/blog/tags/quality.md)
- [One post tagged with "Queries"](/blog/tags/queries.md)
- [One post tagged with "Remote Schema"](/blog/tags/remote-schema.md)
- [One post tagged with "Reports"](/blog/tags/reports.md)
- [3 posts tagged with "Scale"](/blog/tags/scale.md)
- [3 posts tagged with "Schema"](/blog/tags/schema.md)
- [One post tagged with "Schema Explorer"](/blog/tags/schema-explorer.md)
- [2 posts tagged with "Schema Registry"](/blog/tags/schema-registry.md)
- [2 posts tagged with "SDK"](/blog/tags/sdk.md)
- [One post tagged with "Search"](/blog/tags/search.md)
- [One post tagged with "September"](/blog/tags/september.md)
- [4 posts tagged with "Services"](/blog/tags/services.md)
- [One post tagged with "Skills"](/blog/tags/skills.md)
- [One post tagged with "Slack"](/blog/tags/slack.md)
- [One post tagged with "SSR"](/blog/tags/ssr.md)
- [One post tagged with "Static Sites"](/blog/tags/static-sites.md)
- [One post tagged with "Themes"](/blog/tags/themes.md)
- [25 posts tagged with "Update"](/blog/tags/update.md)
- [One post tagged with "User Experience"](/blog/tags/user-experience.md)
- [One post tagged with "versioning"](/blog/tags/versioning.md)
- [2 posts tagged with "Visualiser"](/blog/tags/visualiser.md)
- [One post tagged with "Visualization"](/blog/tags/visualization.md)
- [3 posts tagged with "Visualizer"](/blog/tags/visualizer.md)

### visualizer-improvements

The EventCatalog visualizer just got a complete overhaul. Cleaner nodes, smarter layouts, dark mode support, hover highlighting and more.

- [See your architecture clearly: Major visualizer improvements](/blog/visualizer-improvements.md): The EventCatalog visualizer just got a complete overhaul. Cleaner nodes, smarter layouts, dark mode support, hover highlighting and more.

### visualizer-layout-persistence

Take control of how your architecture diagrams look and share custom layouts with your team

- [Rearrange and save your visualizer layouts](/blog/visualizer-layout-persistence.md): Take control of how your architecture diagrams look and share custom layouts with your team

## changelog

Latest updates and improvements to EventCatalog

- [Changelog](/changelog.md): Latest updates and improvements to EventCatalog

## code-of-conduct

- [tODO](/code-of-conduct.md)

## contact-us

Open source project to help you document your event-driven architectures.

- [Contact Us](/contact-us.md): Open source project to help you document your event-driven architectures.

## enterprise

Open source project to help you document your event-driven architectures.

- [EventCatalog  Enterprise Support](/enterprise.md): Open source project to help you document your event-driven architectures.

## features


### ai-assistant

AI-powered assistant for your EventCatalog documentation.

- [Bring your own models to find the information you need in seconds, not days.](/features/ai-assistant.md): AI-powered assistant for your EventCatalog documentation.

### business-flows

Document business flows and processes with EventCatalog.

- [Go from documentation to design](/features/business-flows.md): Document business flows and processes with EventCatalog.

### change

Merge your team catalogs into a single view with EventCatalog Federation.

- [Track changes across your architecture](/features/change.md): Merge your team catalogs into a single view with EventCatalog Federation.

### documentation

Document domains, services, events, and schemas as first-class architectural primitives. Stored in Git, owned by teams.

- [Architecture documentation your team will actually use.](/features/documentation.md): Document domains, services, events, and schemas as first-class architectural primitives. Stored in Git, owned by teams.

### query

Query your architecture with AI. Built-in MCP server with 15 tools, natural language Q&A, and llms.txt auto-generation.

- [Ask your architectureanything.](/features/query.md): Query your architecture with AI. Built-in MCP server with 15 tools, natural language Q&A, and llms.txt auto-generation.

### visualization

See how your services connect, how data flows, and how messages move through your system. Generated from your docs, always accurate.

- [See your system as it actually works.](/features/visualization.md): See how your services connect, how data flows, and how messages move through your system. Generated from your docs, always accurate.

## federation

Merge your team catalogs into a single view with EventCatalog Federation.

- [EventCatalog for Enterprise](/federation.md): Merge your team catalogs into a single view with EventCatalog Federation.

## index%20copy

- [Page Not Found](/index%20copy.md)

## integrations

Example integrations page layout

- [Integrate with your tools](/integrations.md): Example integrations page layout

### amazon-api-gateway

- [Amazon API Gateway](/integrations/amazon-api-gateway.md)

### amazon-eventbridge

- [Amazon EventBridge](/integrations/amazon-eventbridge.md)

### apicurio

- [Apicurio Registry](/integrations/apicurio.md)

### asyncapi

- [AsyncAPI](/integrations/asyncapi.md)

### atlassian-compass

- [Atlassian Compass](/integrations/atlassian-compass.md)

### aws-glue-registry

- [AWS Glue Schema Registry](/integrations/aws-glue-registry.md)

### azure-schema-registry

- [Azure Schema Registry](/integrations/azure-schema-registry.md)

### backstage

- [Backstage](/integrations/backstage.md)

### claude

- [Claude Desktop](/integrations/claude.md)

### confluent-schema-registry

- [Confluent Schema Registry](/integrations/confluent-schema-registry.md)

### cursor

- [Cursor](/integrations/cursor.md)

### drawio

- [DrawIO](/integrations/drawio.md)

### figjam

- [FigJam](/integrations/figjam.md)

### github

- [GitHub](/integrations/github.md)

### graphql

- [GraphQL](/integrations/graphql.md)

### helm

- [Helm](/integrations/helm.md)

### hookdeck

- [Hookdeck integration](/integrations/hookdeck.md)

### icepanel

- [IcePanel](/integrations/icepanel.md)

### lucid

- [Lucid](/integrations/lucid.md)

### miro

- [Miro](/integrations/miro.md)

### old

Integrate EventCatalog with your favorite tools and services.

- [Discoverability forIntegrate with your systems using](/integrations/old.md): Integrate EventCatalog with your favorite tools and services.

### openapi

- [OpenAPI](/integrations/openapi.md)

### windsurf

- [Windsurf](/integrations/windsurf.md)

## landing-page-v1

Bring discoverability to your event-driven architectures

- [Know what exists.Know who owns it.Know how it connects.](/landing-page-v1.md): Bring discoverability to your event-driven architectures

## landing-page-v2

Turn your distributed architecture into a searchable, visual, AI-queryable source of truth. Self-hosted, open source.

- [Know what exists. Know who owns it. Know how it connects.](/landing-page-v2.md): Turn your distributed architecture into a searchable, visual, AI-queryable source of truth. Self-hosted, open source.

## newsletter

Get notified of EventCatalog updates directly to your inbox

- [Email Sign Up  -  EventCatalog](/newsletter.md): Get notified of EventCatalog updates directly to your inbox

## pricing

EventCatalog pricing plans for teams of all sizes

- [Pricing  -  EventCatalog](/pricing.md): EventCatalog pricing plans for teams of all sizes

### small-business-program

Discounted EventCatalog pricing for startups and small businesses

- [Small Business Program  -  EventCatalog](/pricing/small-business-program.md): Discounted EventCatalog pricing for startups and small businesses

## privacy

Privacy Policy for EventCatalog

- [Privacy Policy](/privacy.md): Privacy Policy for EventCatalog

## product


### documentation

Merge your team catalogs into a single view with EventCatalog Federation.

- [Architecture documentation for your teams](/product/documentation.md): Merge your team catalogs into a single view with EventCatalog Federation.

## search

- [Search the documentation](/search.md)

## services

Get expert guidance on event-driven architecture governance and implementation

- [Expert support for your event-driven journey](/services.md): Get expert guidance on event-driven architecture governance and implementation

## services2

- [EventCatalog Professional Services](/services2.md)

## specifications


### asyncapi

Turn your AsyncAPI specifications into a cohesive, discoverable, and interactive documentation portal.

- [Discoverability forYour central hub for](/specifications/asyncapi.md): Turn your AsyncAPI specifications into a cohesive, discoverable, and interactive documentation portal.

## support

Open source project to help you document your event-driven architectures.

- [Help fix discoverability  Sponsor our project](/support.md): Open source project to help you document your event-driven architectures.

## terms

Terms of Service for EventCatalog

- [Terms of Service](/terms.md): Terms of Service for EventCatalog

## use-cases

Discover how teams use EventCatalog to document, visualize, and govern their event-driven architectures.

- [How teams are using EventCatalog](/use-cases.md): Discover how teams use EventCatalog to document, visualize, and govern their event-driven architectures.

### ai-llm-context-foundation

Give your AI assistants the architectural context they need. EventCatalog becomes the source of truth that LLMs can query to understand your domains, services, events, and organizational boundaries.

- [AI/LLM Context Foundation](/use-cases/ai-llm-context-foundation.md): Give your AI assistants the architectural context they need. EventCatalog becomes the source of truth that LLMs can query to understand your domains, services, events, and organizational boundaries.

### architecture-documentation

Document your software architecture with a tool designed specifically for software primitives. Bring all your architecture artifacts into one place, version them with Git, and make them discoverable for humans and AI.

- [Architecture Documentation](/use-cases/architecture-documentation.md): Document your software architecture with a tool designed specifically for software primitives. Bring all your architecture artifacts into one place, version them with Git, and make them discoverable for humans and AI.

### architecture-planning

Plan your future architecture alongside your current state. Use drafts, versioning, and visual comparison to design changes before writing code.

- [Architecture Planning](/use-cases/architecture-planning.md): Plan your future architecture alongside your current state. Use drafts, versioning, and visual comparison to design changes before writing code.

### automated-documentation

Sync documentation from your OpenAPI and AsyncAPI specs. Automate what changes, keep manual control over business context.

- [Automated Documentation](/use-cases/automated-documentation.md): Sync documentation from your OpenAPI and AsyncAPI specs. Automate what changes, keep manual control over business context.

### beyond-api-documentation

EventCatalog is more than an API documentation tool. Capture business context, flows, domains, team ownership, and ubiquitous language alongside your technical specifications.

- [Not Just an API Documentation Tool](/use-cases/beyond-api-documentation.md): EventCatalog is more than an API documentation tool. Capture business context, flows, domains, team ownership, and ubiquitous language alongside your technical specifications.

### breaking-change-detection

Understand the downstream impact of schema changes before they reach production. Visualize consumers, detect breaking changes with AI, and coordinate changes across distributed teams.

- [Breaking Change Detection](/use-cases/breaking-change-detection.md): Understand the downstream impact of schema changes before they reach production. Visualize consumers, detect breaking changes with AI, and coordinate changes across distributed teams.

### ci-cd-integration

Integrate EventCatalog into your CI/CD pipelines. Rebuild your catalog automatically when schemas change, on a schedule, or on demand.

- [CI/CD Integration](/use-cases/ci-cd-integration.md): Integrate EventCatalog into your CI/CD pipelines. Rebuild your catalog automatically when schemas change, on a schedule, or on demand.

### domain-driven-design

Document your domain model with first-class support for domains, bounded contexts, ubiquitous language, and team ownership. Map business context to technical implementation.

- [Domain-Driven Design Documentation](/use-cases/domain-driven-design.md): Document your domain model with first-class support for domains, bounded contexts, ubiquitous language, and team ownership. Map business context to technical implementation.

### schema-documentation

Transform technical schemas into business-contextualized documentation. Sync from any source, enrich with ownership and purpose, track changes over time.

- [Enrich Schemas with Documentation](/use-cases/schema-documentation.md): Transform technical schemas into business-contextualized documentation. Sync from any source, enrich with ownership and purpose, track changes over time.

## workshops

Hands-on workshops to master event-driven architecture and EventCatalog.

- [De-Risk Your EDA.  Scale with Confidence.](/workshops.md): Hands-on workshops to master event-driven architecture and EventCatalog.

## docs

A collection of guides to help you understand domains and how they work with EventCatalog.

- [Creating domains](/docs.md): A collection of guides to help you understand domains and how they work with EventCatalog.

### adding-to-services

- [Adding to services](/docs/adding-to-services.md)

### amazon-apigateway

Amazon API Gateway integration documentation for EventCatalog

- [Amazon API Gateway](/docs/amazon-apigateway.md): Amazon API Gateway integration documentation for EventCatalog

### amazon-eventbridge

Amazon EventBridge integration documentation for EventCatalog

- [Amazon EventBridge](/docs/amazon-eventbridge.md): Amazon EventBridge integration documentation for EventCatalog

### api

- [Channel frontmatter API](/docs/api/channel-api.md): Understanding the API for channels.
- [Code blocks](/docs/api/code-blocks.md): Understanding what is possible with EventCatalog code blocks
- [Command frontmatter API](/docs/api/command-api.md): Understanding the API for commands.
- [eventcatalog.config.js](/docs/api/config.md): Understanding the configuration file for EventCatalog.
- [Data frontmatter API](/docs/api/data-api.md): Understanding the API for data.
- [Data Product frontmatter API](/docs/api/data-product-api.md): Understanding the API for data products
- [Domain frontmatter API](/docs/api/domain-api.md): Understanding the API for domains.
- [Entity frontmatter API](/docs/api/entity-api.md): Understanding the API for entities.
- [Event frontmatter API](/docs/api/event-api.md): Understanding the API for events.
- [Flow frontmatter API](/docs/api/flow-api.md): Understanding the API for flows.
- [EventCatalog CLI](/docs/api/overview.md): Understand the CLI of EventCatalog
- [Query frontmatter API](/docs/api/query-api.md): Understanding the API for queries.
- [Service frontmatter API](/docs/api/service-api.md): Understanding the API for services.

### apicurio

Apicurio Registry integration for EventCatalog

- [Apicurio Registry](/docs/apicurio.md): Apicurio Registry integration for EventCatalog

### ask-your-architecture

Learn how to integrate your LLM models with EventCatalog.

- [Ask your architecture](/docs/ask-your-architecture.md): Learn how to integrate your LLM models with EventCatalog.

### asyncapi

AsyncAPI integration documentation for EventCatalog

- [AsyncAPI](/docs/asyncapi.md): AsyncAPI integration documentation for EventCatalog

### aws-glue-schema-registry

AWS Glue Schema Registry integration documentation for EventCatalog

- [AWS Glue Schema Registry](/docs/aws-glue-schema-registry.md): AWS Glue Schema Registry integration documentation for EventCatalog

### azure-schema-registry

Azure Schema Registry integration for EventCatalog

- [Azure Schema Registry](/docs/azure-schema-registry.md): Azure Schema Registry integration for EventCatalog

### backstage

Backstage integration with EventCatalog

- [Backstage](/docs/backstage.md): Backstage integration with EventCatalog

### bring-your-own-documentation

Bring your own documentation to EventCatalog. Add global custom pages or attach docs directly to individual resources.

- [Bring your own documentation](/docs/bring-your-own-documentation.md): Bring your own documentation to EventCatalog. Add global custom pages or attach docs directly to individual resources.

### category

- [Contributing to the Miro App](/docs/category/contributing.md): Help improve the EventCatalog Miro App
- [Diagrams](/docs/category/diagrams.md): Learn how to document your architecture with reusable diagrams
- [EventCatalog Studio Documentation](/docs/category/diagrams-1.md): EventCatalog Studio Documentation
- [EventCatalog Studio Documentation](/docs/category/enterprise.md): EventCatalog Studio Documentation
- [EventCatalog Studio Documentation](/docs/category/getting-started.md): EventCatalog Studio Documentation
- [Getting Started with the Miro App](/docs/category/getting-started-1.md): Install and connect EventCatalog to Miro
- [Miro App Guides](/docs/category/guides.md): Learn how to use the EventCatalog Miro app to visualize and manage your architecture
- [Import OpenAPI & AsyncAPI into Miro](/docs/category/import-from-specifications.md): Use EventCatalog plugins to import your API specifications and visualize them in Miro
- [EventCatalog Studio Documentation](/docs/category/organization--teams.md): EventCatalog Studio Documentation
- [EventCatalog Studio Documentation](/docs/category/project.md): EventCatalog Studio Documentation
- [Using AI with the Miro App](/docs/category/using-ai.md): Use AI to turn your Miro board designs into EventCatalog documentation

### changelogs

A collection of guides to help you understand changelogs and how they work with EventCatalog.

- [Changelogs](/docs/changelogs.md): A collection of guides to help you understand changelogs and how they work with EventCatalog.

### channels

A collection of guides to help you understand channels and how they work with EventCatalog.

- [Channels](/docs/channels.md): A collection of guides to help you understand channels and how they work with EventCatalog.
- [Ownership & components](/docs/channels/ownership-and-components.md): A collection of guides to help you understand entities and how they work with EventCatalog.
- [Versioning & lifecycle](/docs/channels/versioning-and-lifecycle.md): A collection of guides to help you understand entities and how they work with EventCatalog.
- [Versioning & lifecycle](/docs/channels/versioning-and-lifecycle.md): A collection of guides to help you understand entities and how they work with EventCatalog.

### cli

The EventCatalog CLI allows you to interact with your EventCatalog directly from the command line. Execute any SDK function without writing code.

- [EventCatalog CLI](/docs/cli.md): The EventCatalog CLI allows you to interact with your EventCatalog directly from the command line. Execute any SDK function without writing code.
- [Channels CLI Commands](/docs/cli/cli-channels.md): Manage channels in your EventCatalog from the command line.
- [Commands CLI Commands](/docs/cli/cli-commands.md): Manage commands in your EventCatalog from the command line.
- [Custom Docs CLI Commands](/docs/cli/cli-custom-docs.md): Manage custom docs in your EventCatalog from the command line.
- [Data Products CLI Commands](/docs/cli/cli-data-products.md): Manage data products in your EventCatalog from the command line.
- [Data Stores CLI Commands](/docs/cli/cli-data-stores.md): Manage data stores in your EventCatalog from the command line.
- [Diagrams CLI Commands](/docs/cli/cli-diagrams.md): Manage diagrams in your EventCatalog from the command line.
- [Domains CLI Commands](/docs/cli/cli-domains.md): Manage domains in your EventCatalog from the command line.
- [Entities CLI Commands](/docs/cli/cli-entities.md): Manage entities in your EventCatalog from the command line.
- [Events CLI Commands](/docs/cli/cli-events.md): Manage events in your EventCatalog from the command line.
- [Export CLI Commands](/docs/cli/cli-export.md): Manage export in your EventCatalog from the command line.
- [Governance CLI Commands](/docs/cli/cli-governance.md): Manage governance in your EventCatalog from the command line.
- [Import CLI Commands](/docs/cli/cli-import.md): Manage import in your EventCatalog from the command line.
- [Messages CLI Commands](/docs/cli/cli-messages.md): Manage messages in your EventCatalog from the command line.
- [Queries CLI Commands](/docs/cli/cli-queries.md): Manage queries in your EventCatalog from the command line.
- [Services CLI Commands](/docs/cli/cli-services.md): Manage services in your EventCatalog from the command line.
- [Snapshots CLI Commands](/docs/cli/cli-snapshots.md): Manage snapshots in your EventCatalog from the command line.
- [Teams CLI Commands](/docs/cli/cli-teams.md): Manage teams in your EventCatalog from the command line.
- [Users CLI Commands](/docs/cli/cli-users.md): Manage users in your EventCatalog from the command line.
- [Utilities CLI Commands](/docs/cli/cli-utilities.md): Manage utilities in your EventCatalog from the command line.

### commands

A collection of guides to help you understand commands and how they work with EventCatalog.

- [Commands](/docs/commands.md): A collection of guides to help you understand commands and how they work with EventCatalog.

### components

This section describes what components can be used in EventCatalog..

- [Components](/docs/components.md): This section describes what components can be used in EventCatalog..
- [Components](/docs/components/list.md): This section describes what components can be used in EventCatalog..

### configuration

- [Configuration](/docs/configuration/getting-started.md): Learn how to configure EventCatalog.

### confluent-schema-registry

Confluent Schema Registry integration for EventCatalog

- [Confluent Schema Registry](/docs/confluent-schema-registry.md): Confluent Schema Registry integration for EventCatalog

### contributing

- [Contributing to EventCatalog](/docs/contributing/overview.md): Understand how to contribute of EventCatalog

### custom-components

A collection of guides to help your understand and build custom components inside your catalog.

- [Write your own components](/docs/custom-components.md): A collection of guides to help your understand and build custom components inside your catalog.

### customize-sidebars

A collection of guides to help you customize the sidebars in your catalog.

- [Customize Sidebars](/docs/customize-sidebars.md): A collection of guides to help you customize the sidebars in your catalog.

### customize-visualizer

A collection of guides to help you customize the visualizer in your catalog.

- [Customize Visualizer](/docs/customize-visualizer.md): A collection of guides to help you customize the visualizer in your catalog.

### data

A collection of guides to help you understand data resources and how they work with EventCatalog.

- [Data Stores](/docs/data.md): A collection of guides to help you understand data resources and how they work with EventCatalog.
- [Ownership & components](/docs/data/ownership-and-components.md): A collection of guides to help you understand entities and how they work with EventCatalog.

### data-products

A collection of guides to help you understand data products and how they work with EventCatalog.

- [Data Products](/docs/data-products.md): A collection of guides to help you understand data products and how they work with EventCatalog.

### design

This section describes how to use EventCatalog to design workflows and new ideas.

- [Design](/docs/design.md): This section describes how to use EventCatalog to design workflows and new ideas.

### development

- [Analytics](/docs/development/analytics/overview.md): Track page views and user behavior across your catalog
- [Custom Tools](/docs/development/ask-your-architecture/eventcatalog-assistant/bring-your-own-tools.md): Extend EventCatalog Assistant with custom tools to bring real-time data, metrics, and integrations into your architecture conversations
- [Configuration](/docs/development/ask-your-architecture/eventcatalog-assistant/configuration.md): Configure EventCatalog Assistant
- [What is EventCatalog Assistant?](/docs/development/ask-your-architecture/eventcatalog-assistant/what-is-eventcatalog-assistant.md): Learn how EventCatalog Assistant helps users explore documentation using natural language.
- [AI with EventCatalog](/docs/development/ask-your-architecture/intro.md): Architecture documentation for humans and AI
- [Getting started](/docs/development/ask-your-architecture/mcp-server/getting-started.md): Connect MCP clients to your EventCatalog
- [MCP server](/docs/development/ask-your-architecture/mcp-server/introduction.md): Connect AI tools to your architecture catalog
- [Skills](/docs/development/ask-your-architecture/skills.md): Pre-built AI skills for generating EventCatalog documentation
- [Installing AI Skills](/docs/development/ask-your-architecture/skills/installation.md): How to install EventCatalog AI skills for your AI coding agent
- [AI Skills](/docs/development/ask-your-architecture/skills/introduction.md): Pre-built AI skills to help you document your architecture with EventCatalog
- [Slack Integration](/docs/development/ask-your-architecture/slack-integration.md): Query your EventCatalog directly from Slack using the EventCatalog Slack Bot.
- [Deployment](/docs/development/ask-your-architecture/slack-integration/deployment.md): Deploy the bot to production
- [Installation](/docs/development/ask-your-architecture/slack-integration/installation.md): Install and configure the bot
- [Slack integration](/docs/development/ask-your-architecture/slack-integration/introduction.md): Query architecture documentation directly from Slack
- [Slack app setup](/docs/development/ask-your-architecture/slack-integration/slack-app-setup.md): Create and configure your Slack app
- [Troubleshooting](/docs/development/ask-your-architecture/slack-integration/troubleshooting.md): Common issues and solutions
- [Using the bot](/docs/development/ask-your-architecture/slack-integration/usage.md): Query architecture documentation from Slack
- [Enabling authentication](/docs/development/authentication/enabling-authentication.md): Enabling authentication for EventCatalog
- [Authentication Guide](/docs/development/authentication/introduction.md): Introduction to EventCatalog Authentication
- [Providers](/docs/development/authentication/providers.md): Authentication for EventCatalog
- [Setting up Auth0](/docs/development/authentication/providers/setting-up-auth0.md): Setting up Auth0 authentication for EventCatalog
- [Setting up Azure AD (Entra ID)](/docs/development/authentication/providers/setting-up-azure-ad.md): Setting up Microsoft Entra ID authentication for EventCatalog
- [Setting up GitHub](/docs/development/authentication/providers/setting-up-github.md): Setting up GitHub authentication for EventCatalog
- [Setting up Google](/docs/development/authentication/providers/setting-up-google.md): Setting up Google authentication for EventCatalog
- [Setting up Okta](/docs/development/authentication/providers/setting-up-okta.md): Setting up Okta authentication for EventCatalog
- [Role-Based Access Control (RBAC) Middleware](/docs/development/authentication/rbac-middleware.md): Implementing role-based access control with custom middleware in EventCatalog
- [Adding global documentation](/docs/development/bring-your-own-documentation/custom-pages/adding-custom-docs.md): Adding global documentation to your EventCatalog
- [Components](/docs/development/bring-your-own-documentation/custom-pages/components.md): Component list for custom pages
- [Introduction](/docs/development/bring-your-own-documentation/custom-pages/introduction.md): Customize documentation in EventCatalog
- [Adding custom page owners](/docs/development/bring-your-own-documentation/custom-pages/owners.md): Adding owners to custom pages with EventCatalog.
- [Bring your own documentation](/docs/development/bring-your-own-documentation/introduction.md): Bring your own documentation to EventCatalog
- [Adding resource-level documentation](/docs/development/bring-your-own-documentation/resource-docs/adding-resource-docs.md): Place MDX files in a docs/ directory alongside any resource.
- [Configure categories](/docs/development/bring-your-own-documentation/resource-docs/categories.md): Control sidebar labels and ordering for doc type groups using category files.
- [Resource-level documentation](/docs/development/bring-your-own-documentation/resource-docs/introduction.md): Attach documentation pages to any resource in your catalog.
- [Version documents](/docs/development/bring-your-own-documentation/resource-docs/versioning.md): Keep historical versions of resource docs alongside versioned resources.
- [<Attachments />](/docs/development/components/components/01a-attachments.md): Learn how to add attachments to your EventCatalog resources
- [<EntityMap />](/docs/development/components/components/03a-entitymap.md): Component for EventCatalog
- [<Accordion />](/docs/development/components/components/accordian.md): Component for EventCatalog
- [<AccordionGroup />](/docs/development/components/components/accordian-group.md): Component for EventCatalog
- [Admonitions](/docs/development/components/components/admonitions.md): Component for EventCatalog
- [<ChannelInformation />](/docs/development/components/components/channel-information.md): Render channel into EventCatalog
- [<Design />](/docs/development/components/components/design.md): Component for embedding EventCatalog Studio diagrams into your documentation
- [<DrawIO />](/docs/development/components/components/embed-diagrams/drawio.md): Embed a DrawIO diagram in your documentation
- [<FigJam />](/docs/development/components/components/embed-diagrams/figjam.md): Embed a FigJam diagram in your documentation
- [<IcePanel />](/docs/development/components/components/embed-diagrams/icepanel.md): Embed an IcePanel diagram in your documentation
- [<Lucid />](/docs/development/components/components/embed-diagrams/lucid.md): Embed a Lucid diagram in your documentation
- [<Miro />](/docs/development/components/components/embed-diagrams/miro.md): Embed a Miro board in your documentation
- [<Flow />](/docs/development/components/components/flow.md): Render a Flow in any EventCatalog page
- [<Link />](/docs/development/components/components/link.md): Create links in your documentation
- [<MermaidFileLoader />](/docs/development/components/components/mermaid-file-loader.md): Component for embedding EventCatalog Studio diagrams into your documentation
- [<MessageTable />](/docs/development/components/components/message-table.md): Component for displaying messages for services and domains in EventCatalog
- [<NodeGraph />](/docs/development/components/components/nodegraph.md): Component for EventCatalog
- [<OpenAPI />](/docs/development/components/components/openapi.md): Component for EventCatalog
- [<RemoteSchema />](/docs/development/components/components/remote-schema.md): Component for fetching and rendering remote schemas in EventCatalog
- [<ResourceGroupTable />](/docs/development/components/components/resource-group-table.md): Component for displaying EventCatalog grouped resources in EventCatalog
- [<ResourceLink />](/docs/development/components/components/resource-link.md): Create links in your documentation to resources in EventCatalog
- [<Schema />](/docs/development/components/components/schema.md): Component for EventCatalog
- [<SchemaViewer />](/docs/development/components/components/schema-viewer.md): Render JSON schema in EventCatalog
- [<Steps />](/docs/development/components/components/steps.md): Render steps into EventCatalog
- [<Tabs />](/docs/development/components/components/tabs.md): Render tabs in your EventCatalog pages
- [<Tiles />](/docs/development/components/components/tiles.md): Render tiles into EventCatalog
- [Using IcePanel](/docs/development/components/icepanel.md): Understanding how to embed IcePanel diagrams in EventCatalog
- [Using mermaid](/docs/development/components/mermaid.md): Understanding how to use mermaid with EventCatalog
- [Using plantuml](/docs/development/components/plantuml.md): Understanding how to use plantuml with EventCatalog
- [Resource references](/docs/development/components/resource-references.md): Create inline links to resources with hover tooltips
- [Reusable snippets](/docs/development/components/snippets.md): Understanding how to use snippets with EventCatalog
- [Using Structurizr](/docs/development/components/structurizr.md): Understanding how to use Structurizr with EventCatalog
- [Using components](/docs/development/components/using-components.md): Understanding components
- [Configuration](/docs/development/configuration.md): Configure EventCatalog
- [Configure RSS feeds](/docs/development/configuration/rss-feed.md): Configure RSS feeds for EventCatalog
- [Customization Documentation](/docs/development/customization.md): Learn how to customize EventCatalog.
- [Adding components](/docs/development/customization/custom-components/adding-components.md): Adding custom components to your catalog
- [Component styling](/docs/development/customization/custom-components/component-styling.md): Adding custom components to your catalog
- [Introduction](/docs/development/customization/custom-components/introduction.md): Add custom components to your catalog
- [Client side scripts](/docs/development/customization/custom-components/javascript-components.md): Adding client side scripts to EventCatalog components
- [What is MDX?](/docs/development/customization/custom-components/what-is-mdx.md): What is MDX?
- [Customize landing page](/docs/development/customization/customize-landing-page.md): Customize landing pages in EventCatalog
- [Application Sidebar](/docs/development/customization/customize-sidebars/application-sidebar.md): Pick and customize the application sidebar.
- [Documentation sidebar](/docs/development/customization/customize-sidebars/documentation-sidebar.md): Pick and customize the documentation sidebar.
- [Customize tables](/docs/development/customization/customize-tables.md): Customize tables in EventCatalog
- [Customize visualizer nodes](/docs/development/customization/customize-visualizer/visualizer-nodes.md): Customize the color, label and icon of the visualizer nodes.
- [Themes](/docs/development/customization/themes.md): Customize the look and feel of your catalog with built-in themes, dark/light mode, and custom themes
- [Deployment guides](/docs/development/deployment.md): This section contains deployment tutorials for developers. This includes tutorials for deploying to Heroku, AWS, and other cloud providers.
- [Building Eventcatalog](/docs/development/deployment/build-and-deploy.md): This document describes step by step how to deploy EventCatalog.
- [Building Eventcatalog](/docs/development/deployment/build-ssr-mode.md): This document describes step by step how to deploy EventCatalog.
- [Deployment Workflows](/docs/development/deployment/deployment-workflows.md): This document describes different deployment workflows for EventCatalog.
- [Hosting](/docs/development/deployment/hosting-options.md): This document describes hosting options for EventCatalog.
- [EventCatalog Licenses](/docs/development/deployment/licenses.md): This document describes how EventCatalog licenses work online and offline.
- [Embed Designs into EventCatalog](/docs/development/design/embed-designs-into-eventcatalog.md): Embed Designs into EventCatalog with EventCatalog
- [Further Reading](/docs/development/design/further-reading.md): Further Reading with EventCatalog
- [Import Resources into Studio](/docs/development/design/import-resources.md): Import Resources into Studio with EventCatalog
- [Documentation to Design](/docs/development/design/intro.md): Documentation to Design with EventCatalog
- [EventCatalog Linter](/docs/development/developer-tools/eventcatalog-linter.md): Validate your EventCatalog frontmatter schemas and resource references with the comprehensive EventCatalog Linter
- [AI Reviewer](/docs/development/developer-tools/github-action.md): Integrate EventCatalog with GitHub Actions
- [LLMS.txt](/docs/development/developer-tools/llms.txt.md): Understanding how to use LLMS.txt with EventCatalog and your LLMs
- [MCP Server](/docs/development/developer-tools/mcp-server.md): This section contains tutorials for the EventCatalog MCP Server.
- [schemas.txt](/docs/development/developer-tools/schemas.txt.md): Understanding how to use schemas.txt with EventCatalog and your schemas
- [Getting Started Documentation](/docs/development/getting-started.md): Learn how to install EventCatalog.
- [Development and build](/docs/development/getting-started/develop-and-build.md): Understanding how to develop and build EventCatalog
- [Fundamentals](/docs/development/getting-started/fundamentals.md): Understanding the fundamentals of EventCatalog
- [Installation](/docs/development/getting-started/installation.md): Understanding how to install EventCatalog locally
- [Why EventCatalog?](/docs/development/getting-started/introduction.md): EventCatalog is an open source project to help you bring discoverability to your event-driven architecture.
- [Project structure](/docs/development/getting-started/project-structure.md): Understanding how to structure your EventCatalog project
- [CLI & CI/CD](/docs/development/governance/architecture-change-detection/ci-cd.md): Run governance checks locally and in your CI/CD pipeline
- [Configuration](/docs/development/governance/architecture-change-detection/configuration.md): Configure governance rules with triggers, resource filters, and actions
- [Architecture Change Detection](/docs/development/governance/architecture-change-detection/introduction.md): Know when your event-driven architecture changes. Get notified when services start or stop producing and consuming messages.
- [Pipeline gates](/docs/development/governance/architecture-change-detection/pipeline-gates.md): Block merges automatically when governance rules trigger
- [Recipes](/docs/development/governance/architecture-change-detection/recipes.md): Common governance configurations you can copy and adapt
- [Webhook Payload](/docs/development/governance/architecture-change-detection/webhooks.md): CloudEvents 1.0 payload format sent by governance webhook actions
- [Authentication](/docs/development/guides/auth.md): Authentication for EventCatalog
- [Creating changelogs](/docs/development/guides/changelogs/adding-changelogs.md): Creating and managing changelogs within EventCatalog.
- [Automated diffs](/docs/development/guides/changelogs/automated-changelogs.md): Understanding how EventCatalog automates diffs for your files
- [Understanding changelogs](/docs/development/guides/changelogs/introduction.md): What are changelogs
- [Creating channels](/docs/development/guides/channels/adding-channels.md): Creating and managing channels within EventCatalog.
- [Routing messages through channels](/docs/development/guides/channels/adding-messages-to-services.md): Understanding how to route messages through channels
- [Understanding channels](/docs/development/guides/channels/introduction.md): What are channels? Why are they useful for event-driven architectures?
- [Components](/docs/development/guides/channels/ownership-and-components/components.md): Component list for domains
- [Adding channel owners](/docs/development/guides/channels/ownership-and-components/owners.md): Adding owners to channels with EventCatalog.
- [Service changelogs](/docs/development/guides/channels/versioning-and-lifecycle/changelog.md): Adding changelogs to your channels
- [Versioning](/docs/development/guides/channels/versioning-and-lifecycle/versioning.md): Learn how to version channels
- [Customize your docs sidebar](/docs/development/guides/customize-your-sidebar.md): Customize your docs sidebar to show your own content.
- [Creating data products](/docs/development/guides/data-products/adding-data-products.md): Creating and managing data products
- [Adding to domains](/docs/development/guides/data-products/adding-to-domains.md): Organize data products within domains
- [Data Contracts](/docs/development/guides/data-products/contracts.md): Define schema contracts for outputs
- [Inputs and outputs](/docs/development/guides/data-products/inputs-and-outputs.md): Define dependencies and consumers
- [Understanding data products](/docs/development/guides/data-products/introduction.md): Data as a product for analytics and insights
- [Versioning](/docs/development/guides/data-products/versioning.md): Version data products and track changes
- [Adding schemas to data stores](/docs/development/guides/data/03a-adding-schemas-to-data-stores.md): Adding schemas to data stores
- [Creating data stores](/docs/development/guides/data/adding-data.md): Creating and managing services within EventCatalog.
- [Understanding data stores](/docs/development/guides/data/introduction.md): What are data resources in EventCatalog?
- [Components](/docs/development/guides/data/ownership-and-components/components.md): Component list for data stores
- [Adding data store owners](/docs/development/guides/data/ownership-and-components/owners.md): Adding owners to data stores with EventCatalog.
- [Data store changelogs](/docs/development/guides/data/versioning-and-lifecycle/changelog.md): Adding changelogs to your data stores
- [Deprecating data stores](/docs/development/guides/data/versioning-and-lifecycle/deprecating.md): Deprecating data stores with EventCatalog.
- [Versioning](/docs/development/guides/data/versioning-and-lifecycle/versioning.md): Learn how to version data stores
- [Comparing diagram versions (Scale)](/docs/development/guides/diagrams/comparing-diagrams.md): Side-by-side version comparison for diagrams with EventCatalog Scale
- [Creating diagrams](/docs/development/guides/diagrams/creating-diagrams.md): How to create and organize diagrams in EventCatalog
- [Using diagrams with LLMs](/docs/development/guides/diagrams/diagrams-with-llms.md): How to use your diagrams with AI assistants and LLM tools
- [Understanding diagrams](/docs/development/guides/diagrams/introduction.md): Bring your own diagrams to EventCatalog - version them, compare them, and assign them to any resource
- [Referencing diagrams from resources](/docs/development/guides/diagrams/referencing-diagrams.md): How to link diagrams to domains, services, messages, and other resources
- [Versioning diagrams](/docs/development/guides/diagrams/versioning-diagrams.md): How to create and manage versioned diagrams in EventCatalog
- [Adding data products to domains](/docs/development/guides/domains/creating-domains/adding-data-products-to-domains.md): Organize analytics and data assets within domain boundaries.
- [Creating domains](/docs/development/guides/domains/creating-domains/adding-domains.md): Creating and managing domains within EventCatalog.
- [Adding messages to domains](/docs/development/guides/domains/creating-domains/adding-messages-to-domains.md): Document event flows at the domain level.
- [Adding services to domains](/docs/development/guides/domains/creating-domains/adding-services-to-domains.md): Creating and managing domains within EventCatalog.
- [Creating subdomains](/docs/development/guides/domains/creating-domains/subdomains.md): Creating and managing subdomains within EventCatalog.
- [Domain Integration Map](/docs/development/guides/domains/domain-integration-map.md): Component list for domains
- [Creating entities](/docs/development/guides/domains/entities/adding-entities.md): Creating and managing entities within EventCatalog.
- [Adding entities to domains](/docs/development/guides/domains/entities/adding-entities-to-domains.md): Creating and managing entities within EventCatalog.
- [Entity Maps](/docs/development/guides/domains/entities/domain-entity-map.md): Visualize and explore entity relationships within your domains and services using EventCatalog's Entity Map feature.
- [What are entities?](/docs/development/guides/domains/entities/introduction.md): What are entities? Why are they useful for event-driven architectures?
- [Understanding domains](/docs/development/guides/domains/introduction.md): What are domains? Why are they useful for event-driven architectures?
- [Ubiquitous language](/docs/development/guides/domains/ownership-and-language/adding-ubiquitous-language.md): Creating a Ubiquitous-language dictionary for your domain
- [Adding domain owners](/docs/development/guides/domains/ownership-and-language/owners.md): Adding owners to domains with EventCatalog.
- [Domain changelogs](/docs/development/guides/domains/versioning-and-changelogs/changelog.md): Adding changelogs to your domains
- [Versioning](/docs/development/guides/domains/versioning-and-changelogs/versioning.md): Learn how to version domains
- [EventCatalog Assistant](/docs/development/guides/eventcatalog-assistant.md): EventCatalog Assistant
- [Creating flows](/docs/development/guides/flows/adding-flows.md): Creating and managing flows within EventCatalog.
- [Adding flows to domains](/docs/development/guides/flows/adding-flows-to-domains.md): Associate flows with domains in EventCatalog
- [Adding flows to services](/docs/development/guides/flows/adding-flows-to-services.md): Associate flows with services in EventCatalog
- [Creating a flow (with AI)](/docs/development/guides/flows/create-flow-with-ai.md): Interactively document business flows using an AI agent skill.
- [Flow nodes types](/docs/development/guides/flows/flow-nodes.md): Flow nodes types within EventCatalog.
- [Understanding flows](/docs/development/guides/flows/introduction.md): What are flows? Why are they useful for event-driven architectures?
- [Versioning](/docs/development/guides/flows/versioning.md): Learn how to version flows
- [Creating commands](/docs/development/guides/messages/commands/adding-commands.md): Creating and managing commands within EventCatalog.
- [Understanding commands](/docs/development/guides/messages/commands/introduction.md): What are commands? Why are they useful for event-driven architectures?
- [Adding schemas to messages](/docs/development/guides/messages/common/adding-schemas.md): Understand how to add schemas to your messages.
- [Event changelogs](/docs/development/guides/messages/common/changelog.md): Adding changelogs to your events
- [Components](/docs/development/guides/messages/common/components.md): Component list for domains
- [Deprecating messages](/docs/development/guides/messages/common/deprecating.md): Deprecating messages with EventCatalog.
- [Creating draft messages](/docs/development/guides/messages/common/draft-messages.md): Creating and managing draft messages within EventCatalog.
- [Message examples](/docs/development/guides/messages/common/examples.md): Add usage examples to your messages for quick reference.
- [Grouping messages](/docs/development/guides/messages/common/grouping-messages.md): Learn how to group related messages in the visualiser to reduce clutter.
- [Assigning events to services](/docs/development/guides/messages/common/map-to-producers-and-consumers.md): Understanding how to link events to services
- [Adding event owners](/docs/development/guides/messages/common/owners.md): Adding owners to events with EventCatalog.
- [Patterns for shared messages](/docs/development/guides/messages/common/shared-messages-across-boundaries.md): Understand the patterns for shared messages in EventCatalog.
- [Versioning](/docs/development/guides/messages/common/versioning.md): Learn how to version events
- [Creating events](/docs/development/guides/messages/events/adding-events.md): Creating and managing events within EventCatalog.
- [Understanding events](/docs/development/guides/messages/events/introduction.md): What are events? Why are they useful for event-driven architectures?
- [Overview](/docs/development/guides/messages/overview.md): What are messags in EventCatalog?
- [Creating queries](/docs/development/guides/messages/queries/adding-queries.md): Creating and managing queries within EventCatalog.
- [Understanding queries](/docs/development/guides/messages/queries/introduction.md): What are queries? Why are they useful for event-driven architectures?
- [Creating teams](/docs/development/guides/owners/teams/adding-teams.md): Creating and managing teams within EventCatalog.
- [Understanding teams](/docs/development/guides/owners/teams/introduction.md): What are teams in EventCatalog?
- [Creating users](/docs/development/guides/owners/users/adding-users.md): Creating and managing users within EventCatalog.
- [Understanding users](/docs/development/guides/owners/users/introduction.md): What are users in EventCatalog?
- [Consumer Field Usage](/docs/development/guides/schemas/field-usage.md): Track which services depend on specific message fields.
- [Fields Explorer](/docs/development/guides/schemas/fields-explorer.md): Browse, search, and trace schema fields across all messages in your catalog.
- [Getting started with schemas](/docs/development/guides/schemas/introduction.md): Getting started with schemas in EventCatalog
- [Schema API](/docs/development/guides/schemas/schema-api.md): Get API (GET) access to your schemas for mocking or testing
- [Schema Explorer](/docs/development/guides/schemas/schema-explorer.md): Explore your schemas in the Schema Explorer
- [Schema MCP](/docs/development/guides/schemas/schema-mcp.md): Get access to your schemas for your MCP clients (e.g Cursor, Windsurf, Claude Desktop etc)
- [Creating services](/docs/development/guides/services/adding-services.md): Creating and managing services within EventCatalog.
- [Adding data stores to services](/docs/development/guides/services/adding-to-services/adding-data-stores-to-services.md): Adding data stores to services
- [Adding AsyncAPI specifications](/docs/development/guides/services/adding-to-services/asyncapi.md): Attach an AsyncAPI specification to your service and render them in your documentation
- [Adding entities to services](/docs/development/guides/services/adding-to-services/entities.md): Creating and managing entities within EventCatalog.
- [Adding GraphQL schemas](/docs/development/guides/services/adding-to-services/graphql.md): Add a GraphQL schema to your service and render them in your documentation
- [Adding messages to services](/docs/development/guides/services/adding-to-services/messages.md): Understanding how to add messages to services.
- [Adding OpenAPI specifications](/docs/development/guides/services/adding-to-services/openapi.md): Attach an OpenAPI specification to your service and render them in your documentation
- [Creating external systems](/docs/development/guides/services/creating-external-systems.md): Model third-party services like Stripe, Twilio, or Snowflake as external systems in EventCatalog.
- [Understanding services](/docs/development/guides/services/introduction.md): What are services? Why are they useful for event-driven architectures?
- [Components](/docs/development/guides/services/ownership-and-components/components.md): Component list for domains
- [Adding service owners](/docs/development/guides/services/ownership-and-components/owners.md): Adding owners to services with EventCatalog.
- [Service changelogs](/docs/development/guides/services/versioning-and-lifecycle/changelog.md): Adding changelogs to your services
- [Deprecating services](/docs/development/guides/services/versioning-and-lifecycle/deprecating.md): Deprecating services with EventCatalog.
- [Versioning](/docs/development/guides/services/versioning-and-lifecycle/versioning.md): Learn how to version services
- [Upgrading EventCatalog](/docs/development/upgrading.md): How to upgrade EventCatalog.
- [Upgrade to EventCatalog v2](/docs/development/upgrading/v2.md): How to upgrade to EventCatalog v2.
- [Upgrade to EventCatalog v3](/docs/development/upgrading/v3.md): How to upgrade to EventCatalog v3.

### domains

A collection of guides to help you understand domains and how they work with EventCatalog.

- [Domains](/docs/domains.md): A collection of guides to help you understand domains and how they work with EventCatalog.
- [Creating domain entities](/docs/domains/entities.md): A collection of guides to help you understand entities and how they work with EventCatalog.

### embed-diagrams

This section describes what components can be used in EventCatalog..

- [Embed Diagrams](/docs/embed-diagrams.md): This section describes what components can be used in EventCatalog..

### eventcatalog-federation

Merge multiple EventCatalog instances into a single catalog.

- [EventCatalog Federation](/docs/eventcatalog-federation.md): Merge multiple EventCatalog instances into a single catalog.

### events

A collection of guides to help you understand events and how they work with EventCatalog.

- [Events](/docs/events.md): A collection of guides to help you understand events and how they work with EventCatalog.

### flows

A collection of guides to help you understand flows and how they work with EventCatalog.

- [Flows](/docs/flows.md): A collection of guides to help you understand flows and how they work with EventCatalog.

### github

GitHub integration for EventCatalog

- [GitHub](/docs/github.md): GitHub integration for EventCatalog

### graphql

GraphQL integration documentation for EventCatalog

- [GraphQL](/docs/graphql.md): GraphQL integration documentation for EventCatalog

### guides

A collection of guides for EventCatalog.

- [Documenting your architecture](/docs/guides.md): A collection of guides for EventCatalog.
- [Global documentation](/docs/guides/bring-your-own-documentation/custom-pages.md): Add catalog-wide custom documentation pages to your catalog.
- [Resource-level documentation](/docs/guides/bring-your-own-documentation/resource-docs.md): Attach documentation pages directly to any resource in your catalog.

### hookdeck

Hookdeck integration with EventCatalog

- [Hookdeck](/docs/hookdeck.md): Hookdeck integration with EventCatalog

### messages

A collection of guides to help you understand commands and how they work with EventCatalog.

- [Messages](/docs/messages.md): A collection of guides to help you understand commands and how they work with EventCatalog.
- [Common to all messages](/docs/messages/common.md): A collection of guides to help you understand queries and how they work with EventCatalog.

### miro

- [Adding Resources to the Board](/docs/miro/adding-resources.md): Drag and drop services, events, commands, and more onto your Miro board
- [Import AsyncAPI into Miro](/docs/miro/asyncapi.md): Import your AsyncAPI specifications into Miro via EventCatalog
- [Connected Resources](/docs/miro/connected-resources.md): View and navigate connections between resources on the board
- [Connecting to EventCatalog](/docs/miro/connecting-to-eventcatalog.md): Export and import your EventCatalog resources into the Miro app
- [Creating New Resources](/docs/miro/creating-resources.md): Create new services, events, and other resources directly from the Miro app
- [Editing Resources](/docs/miro/editing-resources.md): Edit resource details by selecting nodes on the board
- [Exporting to EventCatalog](/docs/miro/exporting-to-eventcatalog.md): Export your Miro board design back to EventCatalog
- [Getting Involved](/docs/miro/getting-involved.md): How to contribute to the EventCatalog Miro App
- [Installing the Miro App](/docs/miro/installation.md): How to install the EventCatalog Miro app to your Miro board
- [Navigating the Board](/docs/miro/navigating-the-board.md): Navigate between connected resources and organize your board layout
- [Import OpenAPI into Miro](/docs/miro/openapi.md): Import your OpenAPI specifications into Miro via EventCatalog
- [EventCatalog Miro App](/docs/miro/overview.md): Bring your EventCatalog architecture into Miro for collaborative visual design
- [Import from Schema Registries](/docs/miro/schema-registries.md): Import schemas from your registry into Miro via EventCatalog
- [Services and Dependencies](/docs/miro/services-and-dependencies.md): Control whether services are added with their full dependency graph or standalone
- [From Miro to EventCatalog with AI](/docs/miro/using-ai.md): Use AI to turn your Miro board designs into EventCatalog documentation automatically

### openapi

OpenAPI integration documentation for EventCatalog

- [OpenAPI](/docs/openapi.md): OpenAPI integration documentation for EventCatalog

### owners

A collection of guides to help you understand owners and how they work with EventCatalog.

- [Teams & Users](/docs/owners.md): A collection of guides to help you understand owners and how they work with EventCatalog.

### ownership-and-components

A collection of guides to help you understand entities and how they work with EventCatalog.

- [Ownership & components](/docs/ownership-and-components.md): A collection of guides to help you understand entities and how they work with EventCatalog.

### ownership-and-language

- [Versioning & changelogs](/docs/ownership-and-language.md)

### plugins

- [All EventCatalog plugins](/docs/plugins/all-plugins.md): All EventCatalog plugins
- [Examples](/docs/plugins/amazon-apigateway/examples.md): Examples of using the Amazon API Gateway plugin
- [Features](/docs/plugins/amazon-apigateway/features.md): Features of AsyncAPI with EventCatalog
- [Installation](/docs/plugins/amazon-apigateway/installation.md): Installation instructions for the Amazon API Gateway plugin
- [Getting started](/docs/plugins/amazon-apigateway/intro.md): Getting started with Amazon EventBridge plugin
- [Plugin Configuration](/docs/plugins/amazon-apigateway/plugin-configuration.md): Configuration of the Amazon API Gateway plugin
- [Examples](/docs/plugins/apicurio/examples.md): Examples of using the Apicurio Registry plugin
- [Features](/docs/plugins/apicurio/features.md): Features of Apicurio Registry with EventCatalog
- [Installation](/docs/plugins/apicurio/installation.md): Installation of the EventCatalog Apicurio Registry plugin
- [Introduction](/docs/plugins/apicurio/intro.md): Getting started with Apicurio Registry plugin
- [Plugin Configuration](/docs/plugins/apicurio/plugin-configuration.md): Configuration of the EventCatalog Apicurio Registry plugin
- [Workflows](/docs/plugins/asyncapi/03a-workflows.md): Workflows of AsyncAPI with EventCatalog
- [Examples](/docs/plugins/asyncapi/examples.md): Examples of using the AsyncAPI plugin
- [Features](/docs/plugins/asyncapi/features.md): Features of AsyncAPI with EventCatalog
- [Installation](/docs/plugins/asyncapi/installation.md): Installation of the EventCatalog AsyncAPI plugin
- [Introduction](/docs/plugins/asyncapi/intro.md): Getting started with AsyncAPI plugin
- [Plugin Configuration](/docs/plugins/asyncapi/plugin-configuration.md): Configuration of the EventCatalog AsyncAPI plugin
- [Using reference objects](/docs/plugins/asyncapi/using-reference-objects.md): Understanding reference objects with AsyncAPI
- [Installation](/docs/plugins/aws-glue-registry/00a-installation.md): How to install the AWS Glue Schema Registry plugin
- [API Reference](/docs/plugins/aws-glue-registry/api.md): Complete API reference for AWS Glue Schema Registry plugin
- [Examples](/docs/plugins/aws-glue-registry/examples.md): Examples of using AWS Glue Schema Registry with EventCatalog
- [Features](/docs/plugins/aws-glue-registry/features.md): Features of AWS Glue Schema Registry with EventCatalog
- [Getting started](/docs/plugins/aws-glue-registry/intro.md): Getting started with AWS Glue Schema Registry plugin
- [Examples](/docs/plugins/azure-schema-registry/examples.md): Examples of the EventCatalog Azure Schema Registry plugin
- [Features](/docs/plugins/azure-schema-registry/features.md): Features of the EventCatalog Azure Schema Registry plugin
- [Installation](/docs/plugins/azure-schema-registry/installation.md): Installation of the EventCatalog Azure Schema Registry plugin
- [Introduction](/docs/plugins/azure-schema-registry/intro.md): Getting started with Azure Schema Registry plugin
- [Plugin Configuration](/docs/plugins/azure-schema-registry/plugin-configuration.md): Configuration of the EventCatalog Azure Schema Registry plugin
- [Backstage configuration](/docs/plugins/backstage/api.md): Getting started with Backstage and EventCatalog plugin
- [Examples](/docs/plugins/backstage/examples.md): Examples of using the AsyncAPI plugin
- [Installation](/docs/plugins/backstage/installation.md): Installation instructions for the EventCatalog Backstage plugin
- [Getting started](/docs/plugins/backstage/intro.md): Getting started with Backstage plugin
- [Examples](/docs/plugins/confluent-schema-registry/examples.md): Examples of using the AsyncAPI plugin
- [Features](/docs/plugins/confluent-schema-registry/features.md): Features of AsyncAPI with EventCatalog
- [Installation](/docs/plugins/confluent-schema-registry/installation.md): Installation of the EventCatalog Confluent Schema Registry plugin
- [Introduction](/docs/plugins/confluent-schema-registry/intro.md): Getting started with AsyncAPI plugin
- [Plugin Configuration](/docs/plugins/confluent-schema-registry/plugin-configuration.md): Configuration of the EventCatalog Confluent Schema Registry plugin
- [Workflows](/docs/plugins/eventbridge/03a-workflows.md): Workflows of EventBridge with EventCatalog
- [Generator API](/docs/plugins/eventbridge/api.md): Getting started with Amazon EventBridge plugin
- [Examples](/docs/plugins/eventbridge/examples.md): Examples of using the OpenAPI plugin
- [Features](/docs/plugins/eventbridge/features.md): Features of AsyncAPI with EventCatalog
- [Installation](/docs/plugins/eventbridge/installation.md): Installation guide for the EventCatalog Amazon EventBridge plugin
- [Getting started](/docs/plugins/eventbridge/intro.md): Getting started with Amazon EventBridge plugin
- [Setup main catalog](/docs/plugins/eventcatalog-federation/configuration.md): Configuring federation in your EventCatalog
- [Examples](/docs/plugins/eventcatalog-federation/examples.md): Examples of using the Federation plugin
- [Installation](/docs/plugins/eventcatalog-federation/installation.md): Installation of the EventCatalog Federation plugin
- [Introduction](/docs/plugins/eventcatalog-federation/introduction.md): Merge multiple EventCatalog instances into a single catalog
- [Plugin Configuration](/docs/plugins/eventcatalog-federation/plugin-configuration.md): Configuration of the EventCatalog Federation plugin
- [Configuring team catalogs](/docs/plugins/eventcatalog-federation/setup-team-catalog.md): Configuring federation in your EventCatalog
- [Generators](/docs/plugins/generators.md): Understanding EventCatalog generators.
- [Examples](/docs/plugins/github/examples.md): Examples of using the Github plugin
- [Features](/docs/plugins/github/features.md): Features of the Github Plugin with EventCatalog
- [Installation](/docs/plugins/github/installation.md): Installation of the EventCatalog GitHub plugin
- [Introduction](/docs/plugins/github/intro.md): Getting started with GitHub plugin
- [Plugin Configuration](/docs/plugins/github/plugin-configuration.md): Configuration of the EventCatalog GitHub plugin
- [Examples](/docs/plugins/graphql/examples.md): Examples of using the GraphQL plugin
- [Features](/docs/plugins/graphql/features.md): Features of GraphQL with EventCatalog
- [Installation](/docs/plugins/graphql/installation.md): Installation of the EventCatalog GraphQL plugin
- [Introduction](/docs/plugins/graphql/intro.md): Getting started with GraphQL plugin
- [Plugin Configuration](/docs/plugins/graphql/plugin-configuration.md): Configuration of the EventCatalog GraphQL plugin
- [Hookdeck Generator API](/docs/plugins/hookdeck/api.md): Getting started with Hookdeck plugin
- [Hookdeck Generator CLI](/docs/plugins/hookdeck/cli.md): Getting started with Hookdeck plugin as a CLI
- [Getting started](/docs/plugins/hookdeck/intro.md): Getting started with Hookdeck plugin
- [Understanding EventCatalog Plugins](/docs/plugins/intro.md): Understand how to use EventCatalog plugins
- [Workflows](/docs/plugins/openapi/03a-workflows.md): Workflows of OpenAPI with EventCatalog
- [Examples](/docs/plugins/openapi/examples.md): Examples of using the OpenAPI plugin
- [Features](/docs/plugins/openapi/features.md): Features of OpenAPI with EventCatalog
- [Installation](/docs/plugins/openapi/installation.md): Installation of the EventCatalog OpenAPI plugin
- [Getting started](/docs/plugins/openapi/intro.md): Getting started with OpenAPI plugin
- [Plugin Configuration](/docs/plugins/openapi/plugin-configuration.md): Configuration of the EventCatalog OpenAPI plugin

### queries

A collection of guides to help you understand queries and how they work with EventCatalog.

- [Queries](/docs/queries.md): A collection of guides to help you understand queries and how they work with EventCatalog.

### schemas

A collection of guides to help you understand schemas and how they work with EventCatalog.

- [Schemas & Specifications](/docs/schemas.md): A collection of guides to help you understand schemas and how they work with EventCatalog.

### sdk

EventCatalog SDK

- [@eventcatalog/sdk](/docs/sdk.md): EventCatalog SDK
- [Function: addDataProductToDomain()](/docs/sdk/functions/addDataProductToDomain.md): addDataProductToDomain(directory): (id, dataProduct, version?) => Promise\
- [Function: addDataStoreToService()](/docs/sdk/functions/addDataStoreToService.md): addDataStoreToService(directory): (id, operation, dataStore, version?) => Promise\
- [Function: addEntityToDomain()](/docs/sdk/functions/addEntityToDomain.md): addEntityToDomain(directory): (id, entity, version?) => Promise\
- [Function: addEntityToService()](/docs/sdk/functions/addEntityToService.md): addEntityToService(directory): (id, entity, version?) => Promise\
- [Function: addExampleToCommand()](/docs/sdk/functions/addExampleToCommand.md): addExampleToCommand(directory): (id, example, version?) => Promise\
- [Function: addExampleToEvent()](/docs/sdk/functions/addExampleToEvent.md): addExampleToEvent(directory): (id, example, version?) => Promise\
- [Function: addExampleToQuery()](/docs/sdk/functions/addExampleToQuery.md): addExampleToQuery(directory): (id, example, version?) => Promise\
- [Function: addFileToCommand()](/docs/sdk/functions/addFileToCommand.md): addFileToCommand(directory): (id, file, version?, options?) => Promise\
- [Function: addFileToDataProduct()](/docs/sdk/functions/addFileToDataProduct.md): addFileToDataProduct(directory): (id, file, version?) => Promise\
- [Function: addFileToDataStore()](/docs/sdk/functions/addFileToDataStore.md): addFileToDataStore(directory): (id, file, version?) => Promise\
- [Function: addFileToDiagram()](/docs/sdk/functions/addFileToDiagram.md): addFileToDiagram(directory): (id, file, version?) => Promise\
- [Function: addFileToDomain()](/docs/sdk/functions/addFileToDomain.md): addFileToDomain(directory): (id, file, version?) => Promise\
- [Function: addFileToEvent()](/docs/sdk/functions/addFileToEvent.md): addFileToEvent(directory): (id, file, version?, options?) => Promise\
- [Function: addFileToQuery()](/docs/sdk/functions/addFileToQuery.md): addFileToQuery(directory): (id, file, version?, options?) => Promise\
- [Function: addFileToService()](/docs/sdk/functions/addFileToService.md): addFileToService(directory): (id, file, version?) => Promise\
- [Function: addMessageToChannel()](/docs/sdk/functions/addMessageToChannel.md): addMessageToChannel(directory, collection): (id, _message, version?) => Promise\
- [Function: addMessageToDomain()](/docs/sdk/functions/addMessageToDomain.md): addMessageToDomain(directory): (id, direction, message, version?) => Promise\
- [Function: addMessageToService()](/docs/sdk/functions/addMessageToService.md): addMessageToService(directory): (id, direction, event, version?) => Promise\
- [Function: addSchemaToCommand()](/docs/sdk/functions/addSchemaToCommand.md): addSchemaToCommand(directory): (id, schema, version?, options?) => Promise\
- [Function: addSchemaToEvent()](/docs/sdk/functions/addSchemaToEvent.md): addSchemaToEvent(directory): (id, schema, version?, options?) => Promise\
- [Function: addSchemaToQuery()](/docs/sdk/functions/addSchemaToQuery.md): addSchemaToQuery(directory): (id, schema, version?, options?) => Promise\
- [Function: addServiceToDomain()](/docs/sdk/functions/addServiceToDomain.md): addServiceToDomain(directory): (id, service, version?) => Promise\
- [Function: addSubDomainToDomain()](/docs/sdk/functions/addSubDomainToDomain.md): addSubDomainToDomain(directory): (id, subDomain, version?) => Promise\
- [Function: addUbiquitousLanguageToDomain()](/docs/sdk/functions/addUbiquitousLanguageToDomain.md): addUbiquitousLanguageToDomain(directory): (id, ubiquitousLanguageDictionary, version?) => Promise\
- [Function: appendChangelog()](/docs/sdk/functions/appendChangelog.md): appendChangelog(catalogDir): (id, changelog, options) => Promise\
- [Function: channelHasVersion()](/docs/sdk/functions/channelHasVersion.md): channelHasVersion(directory): (id, version?) => Promise\
- [Function: commandHasVersion()](/docs/sdk/functions/commandHasVersion.md): commandHasVersion(directory): (id, version?) => Promise\
- [Function: dataProductHasVersion()](/docs/sdk/functions/dataProductHasVersion.md): dataProductHasVersion(directory): (id, version?) => Promise\
- [Function: dataStoreHasVersion()](/docs/sdk/functions/dataStoreHasVersion.md): dataStoreHasVersion(directory): (id, version?) => Promise\
- [Function: diagramHasVersion()](/docs/sdk/functions/diagramHasVersion.md): diagramHasVersion(directory): (id, version?) => Promise\
- [Function: domainHasVersion()](/docs/sdk/functions/domainHasVersion.md): domainHasVersion(directory): (id, version?) => Promise\
- [Function: dumpCatalog()](/docs/sdk/functions/dumpCatalog.md): dumpCatalog(directory): (options?) => Promise\
- [Function: entityHasVersion()](/docs/sdk/functions/entityHasVersion.md): entityHasVersion(directory): (id, version?) => Promise\
- [Function: eventHasVersion()](/docs/sdk/functions/eventHasVersion.md): eventHasVersion(directory): (id, version?) => Promise\
- [Function: getChangelog()](/docs/sdk/functions/getChangelog.md): getChangelog(catalogDir): (id, options) => Promise\
- [Function: getChannel()](/docs/sdk/functions/getChannel.md): getChannel(directory): (id, version?) => Promise\
- [Function: getChannels()](/docs/sdk/functions/getChannels.md): getChannels(directory): (options?) => Promise\
- [Function: getCommand()](/docs/sdk/functions/getCommand.md): getCommand(directory): (id, version?, options?) => Promise\
- [Function: getCommands()](/docs/sdk/functions/getCommands.md): getCommands(directory): (options?) => Promise\
- [Function: getConsumersOfSchema()](/docs/sdk/functions/getConsumersOfSchema.md): getConsumersOfSchema(directory): (path) => Promise\
- [Function: getCustomDoc()](/docs/sdk/functions/getCustomDoc.md): getCustomDoc(directory): (filePath) => Promise\
- [Function: getCustomDocs()](/docs/sdk/functions/getCustomDocs.md): getCustomDocs(directory): (options?) => Promise\
- [Function: getDataProduct()](/docs/sdk/functions/getDataProduct.md): getDataProduct(directory): (id, version?) => Promise\
- [Function: getDataProducts()](/docs/sdk/functions/getDataProducts.md): getDataProducts(directory): (options?) => Promise\
- [Function: getDataStore()](/docs/sdk/functions/getDataStore.md): getDataStore(directory): (id, version?) => Promise\
- [Function: getDataStores()](/docs/sdk/functions/getDataStores.md): getDataStores(directory): (options?) => Promise\
- [Function: getDiagram()](/docs/sdk/functions/getDiagram.md): getDiagram(directory): (id, version?) => Promise\
- [Function: getDiagrams()](/docs/sdk/functions/getDiagrams.md): getDiagrams(directory): (options?) => Promise\
- [Function: getDomain()](/docs/sdk/functions/getDomain.md): getDomain(directory): (id, version?) => Promise\
- [Function: getDomains()](/docs/sdk/functions/getDomains.md): getDomains(directory): (options?) => Promise\
- [Function: getEntities()](/docs/sdk/functions/getEntities.md): getEntities(directory): (options?) => Promise\
- [Function: getEntity()](/docs/sdk/functions/getEntity.md): getEntity(directory): (id, version?) => Promise\
- [Function: getEvent()](/docs/sdk/functions/getEvent.md): getEvent(directory): (id, version?, options?) => Promise\
- [Function: getEventCatalogConfigurationFile()](/docs/sdk/functions/getEventCatalogConfigurationFile.md): getEventCatalogConfigurationFile(directory): () => Promise\
- [Function: getEvents()](/docs/sdk/functions/getEvents.md): getEvents(directory): (options?) => Promise\
- [Function: getExamplesFromCommand()](/docs/sdk/functions/getExamplesFromCommand.md): getExamplesFromCommand(directory): (id, version?) => Promise\
- [Function: getExamplesFromEvent()](/docs/sdk/functions/getExamplesFromEvent.md): getExamplesFromEvent(directory): (id, version?) => Promise\
- [Function: getExamplesFromQuery()](/docs/sdk/functions/getExamplesFromQuery.md): getExamplesFromQuery(directory): (id, version?) => Promise\
- [Function: getFlow()](/docs/sdk/functions/getFlow.md): getFlow(directory): (id, version?) => Promise\
- [Function: getFlows()](/docs/sdk/functions/getFlows.md): getFlows(directory): (options?) => Promise\
- [Function: getMessageBySchemaPath()](/docs/sdk/functions/getMessageBySchemaPath.md): getMessageBySchemaPath(directory): (path, options?) => Promise\
- [Function: getOwnersForResource()](/docs/sdk/functions/getOwnersForResource.md): getOwnersForResource(catalogDir): (id, version?) => Promise\
- [Function: getProducersAndConsumersForMessage()](/docs/sdk/functions/getProducersAndConsumersForMessage.md): getProducersAndConsumersForMessage(directory): (id, version?, options?) => Promise\
- [Function: getProducersOfSchema()](/docs/sdk/functions/getProducersOfSchema.md): getProducersOfSchema(directory): (path) => Promise\
- [Function: getQueries()](/docs/sdk/functions/getQueries.md): getQueries(directory): (options?) => Promise\
- [Function: getQuery()](/docs/sdk/functions/getQuery.md): getQuery(directory): (id, version?, options?) => Promise\
- [Function: getSchemaForMessage()](/docs/sdk/functions/getSchemaForMessage.md): getSchemaForMessage(directory): (id, version?) => Promise\
- [Function: getService()](/docs/sdk/functions/getService.md): getService(directory): (id, version?) => Promise\
- [Function: getServiceByPath()](/docs/sdk/functions/getServiceByPath.md): getServiceByPath(directory): (path) => Promise\
- [Function: getServices()](/docs/sdk/functions/getServices.md): getServices(directory): (options?) => Promise\
- [Function: getSpecificationFilesForService()](/docs/sdk/functions/getSpecificationFilesForService.md): getSpecificationFilesForService(directory): (id, version?) => Promise\
- [Function: getTeam()](/docs/sdk/functions/getTeam.md): getTeam(catalogDir): (id) => Promise\
- [Function: getTeams()](/docs/sdk/functions/getTeams.md): getTeams(catalogDir): (options?) => Promise\
- [Function: getUbiquitousLanguageFromDomain()](/docs/sdk/functions/getUbiquitousLanguageFromDomain.md): getUbiquitousLanguageFromDomain(directory): (id, version?) => Promise\
- [Function: getUser()](/docs/sdk/functions/getUser.md): getUser(catalogDir): (id) => Promise\
- [Function: getUsers()](/docs/sdk/functions/getUsers.md): getUsers(catalogDir): (options?) => Promise\
- [Function: isService()](/docs/sdk/functions/isService.md): isService(directory): (path) => Promise\
- [Function: queryHasVersion()](/docs/sdk/functions/queryHasVersion.md): queryHasVersion(directory): (id, version?) => Promise\
- [Function: removeExampleFromCommand()](/docs/sdk/functions/removeExampleFromCommand.md): removeExampleFromCommand(directory): (id, fileName, version?) => Promise\
- [Function: removeExampleFromEvent()](/docs/sdk/functions/removeExampleFromEvent.md): removeExampleFromEvent(directory): (id, fileName, version?) => Promise\
- [Function: removeExampleFromQuery()](/docs/sdk/functions/removeExampleFromQuery.md): removeExampleFromQuery(directory): (id, fileName, version?) => Promise\
- [Function: rmChangelog()](/docs/sdk/functions/rmChangelog.md): rmChangelog(catalogDir): (id, options) => Promise\
- [Function: rmChannel()](/docs/sdk/functions/rmChannel.md): rmChannel(directory): (path) => Promise\
- [Function: rmChannelById()](/docs/sdk/functions/rmChannelById.md): rmChannelById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmCommand()](/docs/sdk/functions/rmCommand.md): rmCommand(directory): (path) => Promise\
- [Function: rmCommandById()](/docs/sdk/functions/rmCommandById.md): rmCommandById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmCustomDoc()](/docs/sdk/functions/rmCustomDoc.md): rmCustomDoc(directory): (filePath) => Promise\
- [Function: rmDataProduct()](/docs/sdk/functions/rmDataProduct.md): rmDataProduct(directory): (path) => Promise\
- [Function: rmDataProductById()](/docs/sdk/functions/rmDataProductById.md): rmDataProductById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmDataStore()](/docs/sdk/functions/rmDataStore.md): rmDataStore(directory): (path) => Promise\
- [Function: rmDataStoreById()](/docs/sdk/functions/rmDataStoreById.md): rmDataStoreById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmDiagram()](/docs/sdk/functions/rmDiagram.md): rmDiagram(directory): (path) => Promise\
- [Function: rmDiagramById()](/docs/sdk/functions/rmDiagramById.md): rmDiagramById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmDomain()](/docs/sdk/functions/rmDomain.md): rmDomain(directory): (path) => Promise\
- [Function: rmDomainById()](/docs/sdk/functions/rmDomainById.md): rmDomainById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmEntity()](/docs/sdk/functions/rmEntity.md): rmEntity(directory): (path) => Promise\
- [Function: rmEntityById()](/docs/sdk/functions/rmEntityById.md): rmEntityById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmEvent()](/docs/sdk/functions/rmEvent.md): rmEvent(directory): (path) => Promise\
- [Function: rmEventById()](/docs/sdk/functions/rmEventById.md): rmEventById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmQuery()](/docs/sdk/functions/rmQuery.md): rmQuery(directory): (path) => Promise\
- [Function: rmQueryById()](/docs/sdk/functions/rmQueryById.md): rmQueryById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmService()](/docs/sdk/functions/rmService.md): rmService(directory): (path) => Promise\
- [Function: rmServiceById()](/docs/sdk/functions/rmServiceById.md): rmServiceById(directory): (id, version?, persistFiles?) => Promise\
- [Function: rmTeamById()](/docs/sdk/functions/rmTeamById.md): rmTeamById(catalogDir): (id) => Promise\
- [Function: rmUserById()](/docs/sdk/functions/rmUserById.md): rmUserById(catalogDir): (id) => Promise\
- [Function: serviceHasVersion()](/docs/sdk/functions/serviceHasVersion.md): serviceHasVersion(directory): (id, version?) => Promise\
- [Function: toService()](/docs/sdk/functions/toService.md): toService(directory): (file) => Promise\
- [Function: versionChannel()](/docs/sdk/functions/versionChannel.md): versionChannel(directory): (id) => Promise\
- [Function: versionCommand()](/docs/sdk/functions/versionCommand.md): versionCommand(directory): (id) => Promise\
- [Function: versionDataProduct()](/docs/sdk/functions/versionDataProduct.md): versionDataProduct(directory): (id) => Promise\
- [Function: versionDataStore()](/docs/sdk/functions/versionDataStore.md): versionDataStore(directory): (id) => Promise\
- [Function: versionDiagram()](/docs/sdk/functions/versionDiagram.md): versionDiagram(directory): (id) => Promise\
- [Function: versionDomain()](/docs/sdk/functions/versionDomain.md): versionDomain(directory): (id) => Promise\
- [Function: versionEntity()](/docs/sdk/functions/versionEntity.md): versionEntity(directory): (id) => Promise\
- [Function: versionEvent()](/docs/sdk/functions/versionEvent.md): versionEvent(directory): (id) => Promise\
- [Function: versionQuery()](/docs/sdk/functions/versionQuery.md): versionQuery(directory): (id) => Promise\
- [Function: versionService()](/docs/sdk/functions/versionService.md): versionService(directory): (id) => Promise\
- [Function: writeChangelog()](/docs/sdk/functions/writeChangelog.md): writeChangelog(catalogDir): (id, changelog, options) => Promise\
- [Function: writeChannel()](/docs/sdk/functions/writeChannel.md): writeChannel(directory): (channel, options) => Promise\
- [Function: writeCommand()](/docs/sdk/functions/writeCommand.md): writeCommand(directory): (command, options) => Promise\
- [Function: writeCommandToService()](/docs/sdk/functions/writeCommandToService.md): writeCommandToService(directory): (command, service, options) => Promise\
- [Function: writeCustomDoc()](/docs/sdk/functions/writeCustomDoc.md): writeCustomDoc(directory): (customDoc, options) => Promise\
- [Function: writeDataProduct()](/docs/sdk/functions/writeDataProduct.md): writeDataProduct(directory): (dataProduct, options) => Promise\
- [Function: writeDataProductToDomain()](/docs/sdk/functions/writeDataProductToDomain.md): writeDataProductToDomain(directory): (dataProduct, domain, options) => Promise\
- [Function: writeDataStore()](/docs/sdk/functions/writeDataStore.md): writeDataStore(directory): (data, options) => Promise\
- [Function: writeDataStoreToService()](/docs/sdk/functions/writeDataStoreToService.md): writeDataStoreToService(directory): (container, service, options) => Promise\
- [Function: writeDiagram()](/docs/sdk/functions/writeDiagram.md): writeDiagram(directory): (diagram, options) => Promise\
- [Function: writeDomain()](/docs/sdk/functions/writeDomain.md): writeDomain(directory): (domain, options) => Promise\
- [Function: writeEntity()](/docs/sdk/functions/writeEntity.md): writeEntity(directory): (entity, options) => Promise\
- [Function: writeEvent()](/docs/sdk/functions/writeEvent.md): writeEvent(directory): (event, options) => Promise\
- [Function: writeEventToService()](/docs/sdk/functions/writeEventToService.md): writeEventToService(directory): (event, service, options) => Promise\
- [Function: writeQuery()](/docs/sdk/functions/writeQuery.md): writeQuery(directory): (query, options) => Promise\
- [Function: writeQueryToService()](/docs/sdk/functions/writeQueryToService.md): writeQueryToService(directory): (query, service, options) => Promise\
- [Function: writeService()](/docs/sdk/functions/writeService.md): writeService(directory): (service, options) => Promise\
- [Function: writeServiceToDomain()](/docs/sdk/functions/writeServiceToDomain.md): writeServiceToDomain(directory): (service, domain, options) => Promise\
- [Function: writeTeam()](/docs/sdk/functions/writeTeam.md): writeTeam(catalogDir): (team, options) => Promise\
- [Function: writeUser()](/docs/sdk/functions/writeUser.md): writeUser(catalogDir): (user, options) => Promise\
- [Function: writeVersionedService()](/docs/sdk/functions/writeVersionedService.md): writeVersionedService(directory): (service) => Promise\

### services

A collection of guides to help you understand services and how they work with EventCatalog.

- [Services](/docs/services.md): A collection of guides to help you understand services and how they work with EventCatalog.

### starting-a-new-project

- [Starting a new project](/docs/starting-a-new-project/getting-started.md): Learn how to install EventCatalog.

### studio

- [Adding comments](/docs/studio/diagrams/adding-comments.md): Understanding how to use comments in EventCatalog Studio
- [Adding documentation](/docs/studio/diagrams/adding-documentation.md): Understanding how to use nodes in EventCatalog Studio
- [Deleting designs](/docs/studio/diagrams/deleting-designs.md): How to delete designs in EventCatalog Studio
- [Export as prompt](/docs/studio/diagrams/diagram-to-prompt.md): Exporting your diagram as a prompt
- [Embed into EventCatalog](/docs/studio/diagrams/eventcatalog-embed.md): Understanding how to use nodes in EventCatalog Studio
- [Import EventCatalog resources](/docs/studio/diagrams/import-eventcatalog-resources.md): Understanding how to import EventCatalog resources into EventCatalog Studio
- [Import & Export](/docs/studio/diagrams/import-export.md): Understanding how to use nodes in EventCatalog Studio
- [Reset your environment](/docs/studio/diagrams/reset-your-environment.md): Understanding how to reset your environment in EventCatalog Studio
- [Templates](/docs/studio/diagrams/templates.md): Using templates in EventCatalog Studio
- [Using nodes](/docs/studio/diagrams/using-nodes.md): Understanding how to use nodes in EventCatalog Studio
- [Version Control & Audits](/docs/studio/enterprise/audits.md): Version Control & Audits for designs in EventCatalog Studio
- [Self-host](/docs/studio/enterprise/self-host.md): Understand the CLI of EventCatalog
- [Getting Started](/docs/studio/getting-started.md): Getting started with EventCatalog Studio
- [Managing your organization](/docs/studio/organization-teams/inviting-users.md): Understand the CLI of EventCatalog
- [Organization settings](/docs/studio/organization-teams/organization-settings.md): Understand the CLI of EventCatalog
- [Upgrade to a paid plan](/docs/studio/organization-teams/upgrade.md): Understand the CLI of EventCatalog
- [Contributing](/docs/studio/project/contributing.md): Understand the CLI of EventCatalog
- [Open Source](/docs/studio/project/opensource.md): Understand the CLI of EventCatalog
- [Roadmap](/docs/studio/project/roadmap.md): Understand the CLI of EventCatalog
- [Welcome to EventCatalog Studio](/docs/studio/welcome.md): Understand the CLI of EventCatalog
- [Why EventCatalog Studio?](/docs/studio/why-studio.md): Understand the CLI of EventCatalog

### teams

A collection of guides to help you understand teams and how they work with EventCatalog.

- [Teams](/docs/teams.md): A collection of guides to help you understand teams and how they work with EventCatalog.

### users

A collection of guides to help you understand users and how they work with EventCatalog.

- [Users](/docs/users.md): A collection of guides to help you understand users and how they work with EventCatalog.

### versioning-and-lifecycle

A collection of guides to help you understand entities and how they work with EventCatalog.

- [Versioning & lifecycle](/docs/versioning-and-lifecycle.md): A collection of guides to help you understand entities and how they work with EventCatalog.