@eventcatalog/core 4.1.3 → 4.1.5

package/dist/docs/development/bring-your-own-documentation/diagrams/07-reference.md

@@ -0,0 +1,144 @@
+---
+keywords:
+- EventCatalog diagrams
+- Diagram frontmatter
+sidebar_label: Reference
+title: Diagrams reference
+description: Frontmatter fields, paths, and routes for diagrams in EventCatalog.
+---
+
+This page lists the fields, paths, and routes supported by diagrams.
+
+## Paths
+
+Diagrams can be created in any `diagrams` folder:
+
+```txt
+/diagrams/{Diagram Name}/index.mdx
+/domains/{Domain Name}/diagrams/{Diagram Name}/index.mdx
+/systems/{System Name}/diagrams/{Diagram Name}/index.mdx
+```
+
+Versioned diagrams use:
+
+```txt
+/diagrams/{Diagram Name}/versioned/{version}/index.mdx
+```
+
+## Routes
+
+| Route | Description |
+|-------|-------------|
+| `/docs/diagrams/{diagram-id}/{version}` | Diagram documentation page. |
+
+## Required fields
+
+### `id` {#id}
+
+- Type: `string`
+
+Unique id of the diagram. EventCatalog uses this for URLs and resource references.
+
+```md title="Example"
+---
+id: checkout-sequence
+---
+```
+
+### `name` {#name}
+
+- Type: `string`
+
+Display name of the diagram.
+
+```md title="Example"
+---
+name: Checkout Sequence
+---
+```
+
+### `version` {#version}
+
+- Type: `string`
+
+Version of the diagram documentation.
+
+```md title="Example"
+---
+version: 1.0.0
+---
+```
+
+## Optional fields
+
+### `summary` {#summary}
+
+- Type: `string`
+
+Short description of the diagram.
+
+```md title="Example"
+---
+summary: Sequence diagram for checkout orchestration.
+---
+```
+
+### `owners` {#owners}
+
+- Type: `array`
+
+An array of team or user ids that own the diagram.
+
+```md title="Example"
+---
+owners:
+  - checkout-platform
+---
+```
+
+### `badges` {#badges}
+
+- Type: `array`
+
+Badges rendered on the diagram page.
+
+```md title="Example"
+---
+badges:
+  - content: Mermaid
+    backgroundColor: blue
+    textColor: blue
+---
+```
+
+### `repository` {#repository}
+
+- Type: `object`
+
+Repository metadata for the diagram.
+
+```md title="Example"
+---
+repository:
+  url: https://github.com/acme/architecture
+---
+```
+
+### `attachments` {#attachments}
+
+- Type: `array`
+
+External links or supporting documents attached to the diagram.
+
+```md title="Example"
+---
+attachments:
+  - title: Source diagram
+    url: https://miro.com/app/board/example
+    type: miro
+---
+```
+
+## Content
+
+Diagram pages can contain any MDX supported by EventCatalog, including Mermaid, PlantUML, Miro, IcePanel, Lucid, Draw.io, FigJam, images, and normal markdown.

package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/_category_.json

@@ -1,10 +1,11 @@
 {
   "label": "Diagrams",
-  "position": 10,
+  "position": 4,
   "collapsible": true,
   "collapsed": true,
   "link": {
     "type": "generated-index",
+    "slug": "bring-your-own-documentation/diagrams",
     "description": "Learn how to document your architecture with reusable diagrams"
   }
 }

package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md

@@ -11,12 +11,10 @@ keywords:
 ---
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
+import PlanBanner from '@site/src/components/MDX/PlanBanner';
 
 <AddedIn version="3.15.0" />
-
-:::info Scale plan required
-Resource-level documentation requires an [EventCatalog Scale plan](https://eventcatalog.dev/pricing).
-:::
+<PlanBanner plan="Scale" />
 
 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.
 

package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md

@@ -11,25 +11,44 @@ keywords:
 ---
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
+import PlanBanner from '@site/src/components/MDX/PlanBanner';
+import ProjectTree from '@site/src/components/MDX/ProjectTree';
 
 <AddedIn version="3.15.0" />
-
-:::info Scale plan required
-Resource docs require an [EventCatalog Scale plan](https://eventcatalog.dev/pricing).
-:::
+<PlanBanner plan="Scale" />
 
 ## Adding resource-level documentation
 
 Place `.mdx` files inside a `docs/` directory under any resource. EventCatalog will automatically pick them up and display them in the resource's sidebar.
 
-```
-services/
-└── OrdersService/
-    ├── index.mdx
-    └── docs/
-        ├── 01-deployment.mdx
-        └── 02-incident-response.mdx
-```
+<ProjectTree
+  items={[
+    {
+      name: 'services',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'OrdersService',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx' },
+            {
+              name: 'docs',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                { name: '01-deployment.mdx', highlight: true },
+                { name: '02-incident-response.mdx', highlight: true },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 ### Frontmatter properties
 
@@ -65,12 +84,20 @@ version: 1.0.0
 
 Files are sorted alphabetically by default. Prefix the file name with a number to control the order.
 
-```
-docs/
-├── 01-deployment.mdx
-├── 02-incident-response.mdx
-└── 03-disaster-recovery.mdx
-```
+<ProjectTree
+  items={[
+    {
+      name: 'docs',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        { name: '01-deployment.mdx', highlight: true },
+        { name: '02-incident-response.mdx', highlight: true },
+        { name: '03-disaster-recovery.mdx', highlight: true },
+      ],
+    },
+  ]}
+/>
 
 The numeric prefix is stripped from the doc's ID and URL, so `01-deployment.mdx` is accessible at `.../pages/deployment`.
 
@@ -80,18 +107,52 @@ You can also set an explicit `order` value in frontmatter, which takes precedenc
 
 Domains and subdomains follow the same pattern.
 
-```
-domains/
-└── E-Commerce/
-    ├── index.mdx
-    └── docs/
-        └── 01-bounded-context.mdx
-    └── subdomains/
-        └── Orders/
-            ├── index.mdx
-            └── docs/
-                └── 01-order-processing.mdx
-```
+<ProjectTree
+  items={[
+    {
+      name: 'domains',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'E-Commerce',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx' },
+            {
+              name: 'docs',
+              type: 'folder',
+              defaultOpen: true,
+              children: [{ name: '01-bounded-context.mdx', highlight: true }],
+            },
+            {
+              name: 'subdomains',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: 'Orders',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [
+                    { name: 'index.mdx' },
+                    {
+                      name: 'docs',
+                      type: 'folder',
+                      defaultOpen: true,
+                      children: [{ name: '01-order-processing.mdx', highlight: true }],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 ## Navigate to a resource doc
 
@@ -111,19 +172,53 @@ http://localhost:3000/docs/services/OrdersService/1.0.0/pages/deployment
 
 Docs can be organised into groups using subdirectories inside `docs/`. Each subdirectory becomes a **doc type** and gets its own section in the resource sidebar.
 
-```
-services/
-└── OrdersService/
-    ├── index.mdx
-    └── docs/
-        ├── adrs/
-        │   └── 01-use-postgres.mdx
-        ├── runbooks/
-        │   ├── 01-deployment.mdx
-        │   └── 02-incident-response.mdx
-        └── guides/
-            └── on-call.mdx
-```
+<ProjectTree
+  items={[
+    {
+      name: 'services',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'OrdersService',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx' },
+            {
+              name: 'docs',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: 'adrs',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [{ name: '01-use-postgres.mdx', highlight: true }],
+                },
+                {
+                  name: 'runbooks',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [
+                    { name: '01-deployment.mdx', highlight: true },
+                    { name: '02-incident-response.mdx', highlight: true },
+                  ],
+                },
+                {
+                  name: 'guides',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [{ name: 'on-call.mdx', highlight: true }],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 The folder name is used as the group label by default. The built-in types `adrs`, `runbooks`, `contracts`, `troubleshooting`, and `guides` are automatically formatted with friendly labels in the sidebar.
 

package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md

@@ -10,8 +10,11 @@ keywords:
 ---
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
+import PlanBanner from '@site/src/components/MDX/PlanBanner';
+import ProjectTree from '@site/src/components/MDX/ProjectTree';
 
 <AddedIn version="2.x.0" />
+<PlanBanner plan="Scale" />
 
 When you group resource docs into subdirectories, each subdirectory becomes a section in the resource sidebar. By default, the section label is the folder name and sections are sorted alphabetically.
 
@@ -21,15 +24,41 @@ When you group resource docs into subdirectories, each subdirectory becomes a se
 
 Place a `category.json` file inside any doc type folder to configure its sidebar label and position.
 
-```
-services/
-└── OrdersService/
-    └── docs/
-        └── runbooks/
-            ├── category.json
-            ├── 01-deployment.md
-            └── 02-incident-response.md
-```
+<ProjectTree
+  items={[
+    {
+      name: 'services',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'OrdersService',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            {
+              name: 'docs',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: 'runbooks',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [
+                    { name: 'category.json', highlight: true },
+                    { name: '01-deployment.md' },
+                    { name: '02-incident-response.md' },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 ```json title="services/OrdersService/docs/runbooks/category.json"
 {

package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md

@@ -9,8 +9,11 @@ keywords:
 ---
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
+import PlanBanner from '@site/src/components/MDX/PlanBanner';
+import ProjectTree from '@site/src/components/MDX/ProjectTree';
 
 <AddedIn version="3.15.0" />
+<PlanBanner plan="Scale" />
 
 ## How versioning works
 
@@ -18,19 +21,65 @@ Resource docs are associated with a specific version of a resource. When you ver
 
 Previous versions of a doc are stored inside the resource's `versioned/` directory, following the same pattern used for versioned resources.
 
-```
-services/
-└── OrdersService/
-    ├── index.mdx
-    ├── docs/
-    │   └── runbooks/
-    │       └── 01-deployment.md        ← current version
-    └── versioned/
-        └── 0.0.2/
-            └── docs/
-                └── runbooks/
-                    └── 01-deployment.md   ← older version
-```
+<ProjectTree
+  items={[
+    {
+      name: 'services',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'OrdersService',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx' },
+            {
+              name: 'docs',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: 'runbooks',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [{ name: '01-deployment.md', highlight: true }],
+                },
+              ],
+            },
+            {
+              name: 'versioned',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: '0.0.2',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [
+                    {
+                      name: 'docs',
+                      type: 'folder',
+                      defaultOpen: true,
+                      children: [
+                        {
+                          name: 'runbooks',
+                          type: 'folder',
+                          defaultOpen: true,
+                          children: [{ name: '01-deployment.md', highlight: true }],
+                        },
+                      ],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 ## Navigate between versions
 

package/dist/docs/development/components/04-snippets.md

@@ -9,8 +9,6 @@ description: Understanding how to use snippets with EventCatalog
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
 
-<AddedIn version="2.48.0" />
-
 Keep your documentation consistent and maintainable with reusable snippets.
 
 In EventCatalog, staying DRY (Don't Repeat Yourself) isn't just for code—it's for documentation too. If you're repeating the same content across multiple pages, consider using a snippet to centralize it. This makes your docs easier to manage and keeps everything in sync.

package/dist/docs/development/components/05-using-components.md

@@ -7,23 +7,13 @@ title: Using components
 description: Understanding components
 ---
 
-EventCatalog uses [MDX](https://mdxjs.com/) under the hood. This gives you the ability to include predefined components inside your contents.
+EventCatalog is powered by [Astro](https://astro.build/) and [MDX](https://mdxjs.com/). This gives you the flexibility to use [prebuilt components](/docs/components/list) or [create your own components](/docs/components/custom-components) for your documentation.
 
-You can add components to your domains, services or messages.
+### Using prebuild components
 
-## Quick links
+EventCatalog comes with a range of prebuilt components, you can use these by adding them to the markdown content of any resource.
 
-In addition to components, use wiki-style syntax for inline resource references with interactive tooltips:
-
-```md
-The [[service|OrdersService]] processes [[event|OrderCreated]] messages.
-```
-
-See [Resource references](/docs/development/components/resource-references) for details.
-
-### Example
-
-You can include any component inside the markdown content. This example renders an Accordion component within an event.
+This example renders an Accordion component within an event.
 
 ```md title="/events/Orders/OrderAmended/index.mdx"
 ---
@@ -63,5 +53,3 @@ Event is raised when an order has been changed.
 
 
 
-
-

package/dist/docs/development/components/07-resource-references.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 5
 keywords:
 - resource references
 - links

package/dist/docs/development/components/_category_.json

@@ -1,12 +1,12 @@
 {
-  "label": "Components & Diagrams",
-  "position": 6,
+  "label": "Components",
+  "position": 7,
   "collapsible": false,
   "collapsed": false,
   "link": {
     "type": "generated-index",
     "slug": "components",
-    "title": "Components & Diagrams",
+    "title": "Components",
     "description": "Use MDX components, diagram syntax, and external embeds in EventCatalog documentation."
   }
 }

package/dist/docs/development/components/components/01-accordian.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 keywords:
 - components
 sidebar_label: Accordion

package/dist/docs/development/components/components/03-admonitions.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 keywords:
 - components
 sidebar_label: Admonitions

package/dist/docs/development/components/components/04-agent-tools.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 4
 keywords:
 - components
 - agents
@@ -36,7 +36,7 @@ The component reads the `tools` array from the current agent's frontmatter, so i
 
 The `<AgentTools/>` component takes no props — it reads the `tools` array from the current agent's frontmatter.
 
-For details on the `tools` frontmatter shape, see [Agent tools](/docs/development/guides/agents/adding-tools).
+For details on the `tools` frontmatter shape, see [Agent tools](/docs/development/guides/resources/agents/adding-tools).
 
 ### Support
 

package/dist/docs/development/components/components/05-attachments.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 5
 keywords:
 - attachments
 - documentation

package/dist/docs/development/components/components/07-design.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 15
+sidebar_position: 7
 keywords:
 - components
 - remote schema
@@ -10,7 +10,6 @@ title: Design
 description: Component for embedding EventCatalog Studio diagrams into your documentation
 ---
 
-import EventCatalogPro from '@site/src/components/MDX/EventCatalogPro';
 import AddedIn from '@site/src/components/MDX/AddedIn';
 
 <AddedIn version="2.56.0" />

package/dist/docs/development/components/components/08-entitymap.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 8
 keywords:
 - components
 sidebar_label: EntityMap
@@ -16,7 +16,7 @@ A component to visually render a domain's entity map.
 The `<EntityMap/>` component is supported in domains, services, and all messages, changelogs, and custom documentation pages.
 
 :::info
-To visualize entities [you need to create entities in EventCatalog](/docs/development/guides/domains/entities/introduction) and assign them to your services or domains.
+To visualize entities [you need to create entities in EventCatalog](/docs/development/guides/resources/entities/introduction) and assign them to your services or domains.
 :::
 
 ## Interactive controls