Skip to main content

Resource-level documentation

Added in eventcatalog@3.15.0
Scale plan required

Resource-level documentation requires an EventCatalog Scale plan.

Resource-level documentation lets you attach documentation pages directly to any resource in your catalog. Instead of keeping ADRs, runbooks, contracts, and guides in a separate tool, you can place them alongside the resource they describe.

Attached docs appear in the resource sidebar, grouped by custom defined types, so readers can navigate between the resource overview and its supporting documentation without leaving the catalog.

Supported resources​

Resource-level documentation can be attached to any of the following resource types:

  • Domains and subdomains
  • Services
  • Events, Commands, Queries
  • Flows, Channels, Containers, Entities, Data products