Skip to main content

Introducing EventCatalog Custom Documentation

· 3 min read
David Boyne
David Boyne
Founder of EventCatalog

I’m excited to share that EventCatalog 2.33.0 is now available. This release introduces the new EventCatalog Custom Documentation feature. This feature allows you to bring your own documentation to EventCatalog.

What does "Custom Documentation" mean?​

In the past EventCatalog has been focused on documenting your domains, services and messages. This has been great for EventCatalog users, but many people wanted the ability to extend the documentation capabilities of EventCatalog.

This is why we are introducing the new EventCatalog Custom Documentation feature. This feature allows you to bring your own documentation to EventCatalog.

EventCatalog Custom DocumentationView the demo

You can now document anything you want in EventCatalog, assign owners to the documentation and use EventCatalog components inside your documentation.

The use cases are endless, but here are some examples:

  • Architecture Decision Records (ADRs)
  • Product documentation
  • Infrastructure documentation
  • Guides and Tutorials
  • Company policies
  • Meeting notes
  • And much more...

What does custom documentation look like in EventCatalog?​

A new sidebar icon has been added to EventCatalog. Clicking this icon will render your custom documentation.

In your EventCatalog you can customize the sidebar of your documentation and the content that is displayed.

EventCatalog Custom DocumentationView the demo

All your custom documentation is stored in the /docs folder, and can be organized in anyway you want. You then configure the sidebar in your eventcatalog.config.js file to configure your sidebar.

You can read the documentation here to get started and start building your own documentation.

Getting started​

You can start adding your custom documentation to your EventCatalog in minutes. You can read the documentation here to get started and start building your own documentation.

Roamap for custom documentation​

This is the first version of custom documentation, in April we are aiming to get the following features out:

  • Import EventCatalog resources into your documentation
    • Import any EventCatalog resource into your documentation, using components
  • Embed EventCatalog visualizations into your documentation
    • Add visualizations to your documentation using new components
  • SDK support for custom documentation
    • Programmatically add documentation to your EventCatalog
  • Adding custom documentation to EventCatalog Chat
    • Ability to ask questions about your documentation, privacy first, unlimited tokens

Summary​

I'm super excited about this release, it's the first step in our journey to make EventCatalog the best tool for documenting your architectures.

If you have any feedback or suggestions please create an issue or join the community on Discord.

I look forward to seeing what you build with this new feature!