@eventcatalog/core 4.1.3 → 4.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (450) hide show
  1. package/dist/analytics/analytics.cjs +1 -1
  2. package/dist/analytics/analytics.js +2 -2
  3. package/dist/analytics/log-build.cjs +1 -1
  4. package/dist/analytics/log-build.js +3 -3
  5. package/dist/{chunk-DDGOJV25.js → chunk-DIUAURE2.js} +1 -1
  6. package/dist/{chunk-WEDJTUSQ.js → chunk-E6IUV4GX.js} +1 -1
  7. package/dist/{chunk-TUKKXNQR.js → chunk-G74MXXTG.js} +1 -1
  8. package/dist/{chunk-PDQER3NQ.js → chunk-GIU3S4CI.js} +1 -1
  9. package/dist/{chunk-G3D7IZ67.js → chunk-X77TET65.js} +1 -1
  10. package/dist/constants.cjs +1 -1
  11. package/dist/constants.js +1 -1
  12. package/dist/docs/api/02-config.md +166 -14
  13. package/dist/docs/api/08-code-blocks.md +1 -1
  14. package/dist/docs/development/00-why-eventcatalog.md +29 -40
  15. package/dist/docs/development/01-fundamentals.md +58 -7
  16. package/dist/docs/development/01-getting-started/configuration-overview.md +1 -93
  17. package/dist/docs/development/01-getting-started/develop-and-build.md +4 -3
  18. package/dist/docs/development/01-getting-started/installation.md +3 -3
  19. package/dist/docs/development/01-getting-started/project-structure.md +74 -141
  20. package/dist/docs/development/ask-your-architecture/01-intro.md +8 -76
  21. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +4 -3
  22. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +2 -1
  23. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +1 -3
  24. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +2 -2
  25. package/dist/docs/development/{developer-tools/llms.txt.md → ask-your-architecture/02-llms.txt.md} +1 -2
  26. package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +2 -2
  27. package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +2 -2
  28. package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +2 -25
  29. package/dist/docs/development/{developer-tools/schemas.txt.md → ask-your-architecture/03-schemas.txt.md} +1 -2
  30. package/dist/docs/development/ask-your-architecture/04-agents/01-overview.md +27 -0
  31. package/dist/docs/development/ask-your-architecture/04-agents/02-code-to-docs.md +124 -0
  32. package/dist/docs/development/ask-your-architecture/04-agents/03-breaking-changes.md +170 -0
  33. package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +12 -0
  34. package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/_category_.json +2 -2
  35. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/03-installation.md +1 -1
  36. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/_category_.json +2 -1
  37. package/dist/docs/development/ask-your-architecture/_category_.json +2 -2
  38. package/dist/docs/development/authentication/01-introduction.md +3 -3
  39. package/dist/docs/development/authentication/02-enabling-authentication.md +2 -2
  40. package/dist/docs/development/authentication/providers/03-setting-up-github.md +25 -1
  41. package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -1
  42. package/dist/docs/development/bring-your-own-documentation/01-introduction.md +29 -25
  43. package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +9 -8
  44. package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +70 -32
  45. package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +4 -1
  46. package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +2 -1
  47. package/dist/docs/development/bring-your-own-documentation/custom-pages/_category_.json +1 -1
  48. package/dist/docs/development/bring-your-own-documentation/diagrams/01-introduction.md +56 -0
  49. package/dist/docs/development/bring-your-own-documentation/diagrams/02-creating-diagrams.md +262 -0
  50. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/03-referencing-diagrams.md +3 -87
  51. package/dist/docs/development/bring-your-own-documentation/diagrams/05-comparing-diagrams.md +25 -0
  52. package/dist/docs/development/bring-your-own-documentation/diagrams/07-reference.md +144 -0
  53. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/_category_.json +2 -1
  54. package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +2 -4
  55. package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +138 -43
  56. package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +38 -9
  57. package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +62 -13
  58. package/dist/docs/development/components/04-snippets.md +0 -2
  59. package/dist/docs/development/components/05-using-components.md +4 -16
  60. package/dist/docs/development/components/07-resource-references.md +1 -1
  61. package/dist/docs/development/components/_category_.json +3 -3
  62. package/dist/docs/development/components/components/01-accordian.md +1 -1
  63. package/dist/docs/development/components/components/03-admonitions.md +1 -1
  64. package/dist/docs/development/components/components/04-agent-tools.md +2 -2
  65. package/dist/docs/development/components/components/05-attachments.md +1 -1
  66. package/dist/docs/development/components/components/07-design.md +1 -2
  67. package/dist/docs/development/components/components/08-entitymap.md +2 -2
  68. package/dist/docs/development/components/components/09-flow.md +1 -1
  69. package/dist/docs/development/components/components/10-link.md +1 -1
  70. package/dist/docs/development/components/components/11-mermaid-file-loader.md +1 -1
  71. package/dist/docs/development/components/components/12-message-table.md +1 -1
  72. package/dist/docs/development/components/components/13-nodegraph.md +1 -1
  73. package/dist/docs/development/components/components/14-openapi.md +3 -3
  74. package/dist/docs/development/components/components/15-prompt.md +2 -6
  75. package/dist/docs/development/components/components/16-remote-schema.md +5 -3
  76. package/dist/docs/development/components/components/17-resource-group-table.md +1 -1
  77. package/dist/docs/development/components/components/18-resource-link.md +1 -1
  78. package/dist/docs/development/components/components/19-schema.md +1 -1
  79. package/dist/docs/development/components/components/20-schema-viewer.md +1 -1
  80. package/dist/docs/development/components/components/21-steps.md +1 -1
  81. package/dist/docs/development/components/components/22-tabs.md +1 -1
  82. package/dist/docs/development/components/components/23-tiles.md +1 -1
  83. package/dist/docs/development/components/components/24-visibility.md +1 -1
  84. package/dist/docs/development/components/components/_category_.json +1 -1
  85. package/dist/docs/development/components/custom-components/01-introduction.md +74 -0
  86. package/dist/docs/development/components/custom-components/02-create-your-first-component.md +71 -0
  87. package/dist/docs/development/components/custom-components/03-pass-data-into-components.md +86 -0
  88. package/dist/docs/development/components/custom-components/04-fetch-data-in-components.md +191 -0
  89. package/dist/docs/development/components/custom-components/05-style-components.md +60 -0
  90. package/dist/docs/development/components/custom-components/06-add-client-side-scripts.md +67 -0
  91. package/dist/docs/development/components/custom-components/07-reference.md +115 -0
  92. package/dist/docs/development/components/custom-components/_category_.json +11 -0
  93. package/dist/docs/development/components/{external-diagram-embeds/03-drawio.md → diagram-syntax/01-drawio.md} +2 -3
  94. package/dist/docs/development/components/{external-diagram-embeds/04-figjam.md → diagram-syntax/02-figjam.md} +1 -2
  95. package/dist/docs/development/components/diagram-syntax/{04-icepanel.md → 03-icepanel.md} +1 -2
  96. package/dist/docs/development/components/diagram-syntax/04-likec4.md +136 -0
  97. package/dist/docs/development/components/{external-diagram-embeds/02-lucid.md → diagram-syntax/05-lucid.md} +2 -3
  98. package/dist/docs/development/components/diagram-syntax/{01-mermaid.md → 06-mermaid.md} +1 -1
  99. package/dist/docs/development/components/{external-diagram-embeds/01-miro.md → diagram-syntax/07-miro.md} +2 -3
  100. package/dist/docs/development/components/diagram-syntax/{02-plantuml.md → 08-plantuml.md} +3 -3
  101. package/dist/docs/development/components/diagram-syntax/{03-structurizr.md → 09-structurizr.md} +1 -1
  102. package/dist/docs/development/components/diagram-syntax/_category_.json +3 -3
  103. package/dist/docs/development/customization/01-customize-landing-page.md +7 -15
  104. package/dist/docs/development/customization/02-themes.md +1 -0
  105. package/dist/docs/development/customization/03-application-sidebar.md +246 -0
  106. package/dist/docs/development/customization/03-search.md +2 -2
  107. package/dist/docs/development/customization/{customize-sidebars/01-documentation-sidebar.md → 04-documentation-sidebar.md} +4 -4
  108. package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +94 -0
  109. package/dist/docs/development/customization/05-custom-pages-and-api-routes/02-create-a-custom-page.md +177 -0
  110. package/dist/docs/development/customization/05-custom-pages-and-api-routes/03-create-an-api-route.md +128 -0
  111. package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +138 -0
  112. package/dist/docs/development/customization/05-custom-pages-and-api-routes/_category_.json +12 -0
  113. package/dist/docs/development/customization/06-customize-tables.md +3 -3
  114. package/dist/docs/development/customization/07-resource-icons.md +190 -0
  115. package/dist/docs/development/customization/_category_.json +1 -1
  116. package/dist/docs/development/customization/customize-visualizer/_category_.json +2 -2
  117. package/dist/docs/development/deployment/hosting-options.md +1 -2
  118. package/dist/docs/development/developer-tools/api-catalog.md +1 -1
  119. package/dist/docs/development/developer-tools/eventcatalog-linter.md +137 -2
  120. package/dist/docs/development/governance/_category_.json +1 -0
  121. package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +2 -2
  122. package/dist/docs/development/guides/98-versioning-resources.md +192 -0
  123. package/dist/docs/development/guides/99-adding-analytics.md +0 -1
  124. package/dist/docs/development/guides/changelogs/02-adding-changelogs.md +2 -2
  125. package/dist/docs/development/guides/changelogs/03-automated-changelogs.md +2 -2
  126. package/dist/docs/development/guides/changelogs/04-reference.md +77 -0
  127. package/dist/docs/development/guides/changelogs/_category_.json +2 -2
  128. package/dist/docs/development/guides/domains/01-introduction.md +14 -9
  129. package/dist/docs/development/guides/domains/{02-creating-domains/02-adding-domains.md → 02-create-domain.md} +32 -16
  130. package/dist/docs/development/guides/domains/{02-creating-domains/02a-subdomains.md → 03-model-subdomains.md} +22 -10
  131. package/dist/docs/development/guides/domains/03-ownership-and-language/01-owners.md +1 -1
  132. package/dist/docs/development/guides/domains/03-ownership-and-language/02-adding-ubiquitous-language.md +2 -6
  133. package/dist/docs/development/guides/domains/03-ownership-and-language/_category_.json +2 -2
  134. package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +154 -0
  135. package/dist/docs/development/guides/domains/{02-creating-domains/03-adding-services-to-domains.md → 04-add-resources-to-domains/02-add-services-to-domains.md} +6 -37
  136. package/dist/docs/development/guides/domains/{02-creating-domains/04-adding-messages-to-domains.md → 04-add-resources-to-domains/03-add-messages-to-domains.md} +4 -6
  137. package/dist/docs/development/guides/domains/{02-creating-domains/05-adding-data-products-to-domains.md → 04-add-resources-to-domains/04-add-data-products-to-domains.md} +6 -5
  138. package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +115 -0
  139. package/dist/docs/development/guides/domains/04-add-resources-to-domains/_category_.json +11 -0
  140. package/dist/docs/development/guides/domains/{08-domain-integration-map.md → 06-visualize-domains/01-domain-integration-map.md} +5 -6
  141. package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +12 -0
  142. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/01-versioning.md → 07-version-domains.md} +5 -6
  143. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/02-changelog.md → 08-add-changelog.md} +6 -7
  144. package/dist/docs/development/guides/domains/09-reference.md +517 -0
  145. package/dist/docs/development/guides/owners/01-what-are-teams-and-users.md +46 -0
  146. package/dist/docs/development/guides/owners/02-create-team.md +110 -0
  147. package/dist/docs/development/guides/owners/03-create-user.md +99 -0
  148. package/dist/docs/development/guides/owners/05-teams-reference.md +144 -0
  149. package/dist/docs/development/guides/owners/06-users-reference.md +128 -0
  150. package/dist/docs/development/guides/owners/_category_.json +2 -2
  151. package/dist/docs/development/guides/owners/automated-teams-and-users/_category_.json +11 -0
  152. package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +108 -0
  153. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +156 -0
  154. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +253 -0
  155. package/dist/docs/development/guides/resources/_category_.json +11 -0
  156. package/dist/docs/development/guides/resources/adrs/01-introduction.md +37 -0
  157. package/dist/docs/development/guides/resources/adrs/02-creating-adrs.md +211 -0
  158. package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +52 -0
  159. package/dist/docs/development/guides/resources/adrs/04-relationships.md +80 -0
  160. package/dist/docs/development/guides/resources/adrs/06-reference.md +247 -0
  161. package/dist/docs/development/guides/resources/adrs/_category_.json +11 -0
  162. package/dist/docs/development/guides/{agents → resources/agents}/01-introduction.md +1 -16
  163. package/dist/docs/development/guides/resources/agents/02-create-agent.md +188 -0
  164. package/dist/docs/development/guides/{agents → resources/agents}/03-adding-tools.md +3 -4
  165. package/dist/docs/development/guides/{agents → resources/agents}/04-model-metadata.md +2 -2
  166. package/dist/docs/development/guides/{agents/adding-to-agents/01-messages.md → resources/agents/05-add-messages-to-agents.md} +5 -4
  167. package/dist/docs/development/guides/{agents/adding-to-agents/02-datastores.md → resources/agents/06-add-data-stores-to-agents.md} +4 -15
  168. package/dist/docs/development/guides/resources/agents/11-reference.md +238 -0
  169. package/dist/docs/development/guides/{agents → resources/agents}/_category_.json +2 -2
  170. package/dist/docs/development/guides/resources/data/01-introduction.md +15 -0
  171. package/dist/docs/development/guides/resources/data/02-adding-data.md +184 -0
  172. package/dist/docs/development/guides/resources/data/03-add-read-write-relationships.md +128 -0
  173. package/dist/docs/development/guides/resources/data/04-reference.md +211 -0
  174. package/dist/docs/development/guides/{data → resources/data}/_category_.json +3 -3
  175. package/dist/docs/development/guides/{data-products → resources/data-products}/01-introduction.md +1 -17
  176. package/dist/docs/development/guides/resources/data-products/02-adding-data-products.md +174 -0
  177. package/dist/docs/development/guides/{data-products → resources/data-products}/03-inputs-and-outputs.md +4 -6
  178. package/dist/docs/development/guides/{data-products → resources/data-products}/04-contracts.md +2 -4
  179. package/dist/docs/development/guides/resources/data-products/07-reference.md +201 -0
  180. package/dist/docs/development/guides/{data-products → resources/data-products}/_category_.json +3 -3
  181. package/dist/docs/development/guides/resources/entities/01-introduction.md +26 -0
  182. package/dist/docs/development/guides/resources/entities/02-create-entity.md +162 -0
  183. package/dist/docs/development/guides/resources/entities/03-model-entity-relationships.md +115 -0
  184. package/dist/docs/development/guides/resources/entities/04-add-entities-to-resources.md +188 -0
  185. package/dist/docs/development/guides/resources/entities/05-entity-maps.md +48 -0
  186. package/dist/docs/development/guides/resources/entities/06-reference.md +273 -0
  187. package/dist/docs/development/guides/{domains/05-entities → resources/entities}/_category_.json +4 -4
  188. package/dist/docs/development/guides/resources/flows/01-introduction.md +28 -0
  189. package/dist/docs/development/guides/resources/flows/02-create-flow.md +304 -0
  190. package/dist/docs/development/guides/{flows/03-flow-nodes.md → resources/flows/03-model-flow-steps.md} +6 -6
  191. package/dist/docs/development/guides/resources/flows/04-add-flows-to-resources.md +149 -0
  192. package/dist/docs/development/guides/resources/flows/06-reference.md +226 -0
  193. package/dist/docs/development/guides/{flows → resources/flows}/_category_.json +3 -3
  194. package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +104 -0
  195. package/dist/docs/development/guides/{messages/events/01-introduction.md → resources/messages/02-message-types/01-events.md} +3 -7
  196. package/dist/docs/development/guides/{messages/commands/01-introduction.md → resources/messages/02-message-types/02-commands.md} +4 -7
  197. package/dist/docs/development/guides/resources/messages/02-message-types/03-queries.md +20 -0
  198. package/dist/docs/development/guides/resources/messages/02-message-types/_category_.json +11 -0
  199. package/dist/docs/development/guides/resources/messages/03-create-messages/01-create-event.md +137 -0
  200. package/dist/docs/development/guides/resources/messages/03-create-messages/02-create-command.md +156 -0
  201. package/dist/docs/development/guides/resources/messages/03-create-messages/03-create-query.md +158 -0
  202. package/dist/docs/development/guides/{messages/common/02-draft-messages.md → resources/messages/03-create-messages/04-create-draft-message.md} +5 -7
  203. package/dist/docs/development/guides/resources/messages/03-create-messages/_category_.json +11 -0
  204. package/dist/docs/development/guides/resources/messages/04-connect-messages/01-map-producers-and-consumers.md +32 -0
  205. package/dist/docs/development/guides/resources/messages/04-connect-messages/02-shared-messages-across-boundaries.md +170 -0
  206. package/dist/docs/development/guides/{messages/common/09-grouping-messages.md → resources/messages/04-connect-messages/03-group-messages.md} +2 -4
  207. package/dist/docs/development/guides/resources/messages/04-connect-messages/_category_.json +11 -0
  208. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/01-introduction.md +4 -28
  209. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/02-adding-channels.md +77 -62
  210. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/04-adding-messages-to-services.md +10 -14
  211. package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +177 -0
  212. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/_category_.json +3 -3
  213. package/dist/docs/development/guides/{messages/common/04-versioning.md → resources/messages/08-versioning-and-lifecycle/01-version-messages.md} +39 -4
  214. package/dist/docs/development/guides/{messages/common/05-changelog.md → resources/messages/08-versioning-and-lifecycle/02-add-changelog.md} +5 -6
  215. package/dist/docs/development/guides/{messages/common/02-deprecating.md → resources/messages/08-versioning-and-lifecycle/03-deprecate-messages.md} +4 -4
  216. package/dist/docs/development/guides/resources/messages/08-versioning-and-lifecycle/_category_.json +11 -0
  217. package/dist/docs/development/guides/{messages/common/02-examples.md → resources/messages/09-add-usage-examples.md} +59 -22
  218. package/dist/docs/development/guides/resources/messages/10-reference.md +439 -0
  219. package/dist/docs/development/guides/resources/messages/_category_.json +11 -0
  220. package/dist/docs/development/guides/resources/schemas/01-what-are-schemas-and-specifications.md +25 -0
  221. package/dist/docs/development/guides/resources/schemas/02-add-schemas-to-messages.md +63 -0
  222. package/dist/docs/development/guides/resources/schemas/03-add-schemas-to-data-stores.md +90 -0
  223. package/dist/docs/development/guides/{services/adding-to-services/04-openapi.md → resources/schemas/03-add-specifications-to-services/01-add-openapi-specifications.md} +33 -24
  224. package/dist/docs/development/guides/{services/adding-to-services/05-asyncapi.md → resources/schemas/03-add-specifications-to-services/02-add-asyncapi-specifications.md} +33 -23
  225. package/dist/docs/development/guides/{services/adding-to-services/06-graphql.md → resources/schemas/03-add-specifications-to-services/03-add-graphql-schemas.md} +36 -26
  226. package/dist/docs/development/guides/resources/schemas/03-add-specifications-to-services/_category_.json +11 -0
  227. package/dist/docs/development/guides/{schemas/02-schema-explorer.md → resources/schemas/04-explore-schemas/01-schema-explorer.md} +3 -26
  228. package/dist/docs/development/guides/{schemas/06-fields-explorer.md → resources/schemas/04-explore-schemas/02-fields-explorer.md} +8 -10
  229. package/dist/docs/development/guides/{schemas/05-field-usage.md → resources/schemas/04-explore-schemas/03-consumer-field-usage.md} +1 -3
  230. package/dist/docs/development/guides/resources/schemas/04-explore-schemas/_category_.json +11 -0
  231. package/dist/docs/development/guides/{schemas/03-schema-api.md → resources/schemas/05-schema-api.md} +6 -11
  232. package/dist/docs/development/guides/{schemas/04-schema-mcp.md → resources/schemas/06-schema-mcp.md} +5 -6
  233. package/dist/docs/development/guides/resources/schemas/07-reference.md +23 -0
  234. package/dist/docs/development/guides/{schemas → resources/schemas}/_category_.json +3 -3
  235. package/dist/docs/development/guides/resources/services/01-introduction.md +27 -0
  236. package/dist/docs/development/guides/resources/services/02-create-service.md +195 -0
  237. package/dist/docs/development/guides/resources/services/03-create-external-service.md +52 -0
  238. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/01-add-messages-to-services.md +142 -0
  239. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/02-add-data-stores-to-services.md +45 -0
  240. package/dist/docs/development/guides/{services/adding-to-services/03-entities.md → resources/services/04-add-resources-to-services/03-add-entities-to-services.md} +7 -11
  241. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/_category_.json +11 -0
  242. package/dist/docs/development/guides/{services/ownership-and-components/01-owners.md → resources/services/06-ownership-and-components/01-add-service-owners.md} +3 -4
  243. package/dist/docs/development/guides/{services/ownership-and-components/02-components.md → resources/services/06-ownership-and-components/02-use-components.md} +4 -4
  244. package/dist/docs/development/guides/resources/services/06-ownership-and-components/_category_.json +11 -0
  245. package/dist/docs/development/guides/{services/versioning-and-lifecycle/01-versioning.md → resources/services/07-versioning-and-lifecycle/01-version-services.md} +4 -3
  246. package/dist/docs/development/guides/{services/versioning-and-lifecycle/02-changelog.md → resources/services/07-versioning-and-lifecycle/02-add-changelog.md} +5 -5
  247. package/dist/docs/development/guides/{services/versioning-and-lifecycle/03-deprecating.md → resources/services/07-versioning-and-lifecycle/03-deprecate-services.md} +5 -4
  248. package/dist/docs/development/guides/resources/services/07-versioning-and-lifecycle/_category_.json +11 -0
  249. package/dist/docs/development/guides/resources/services/08-reference.md +295 -0
  250. package/dist/docs/development/guides/{services → resources/services}/_category_.json +3 -3
  251. package/dist/docs/development/guides/systems/01-introduction.md +119 -0
  252. package/dist/docs/development/guides/systems/02-create-system.md +127 -0
  253. package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +157 -0
  254. package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +86 -0
  255. package/dist/docs/development/guides/systems/05-system-context-maps.md +67 -0
  256. package/dist/docs/development/guides/systems/06-reference.md +329 -0
  257. package/dist/docs/development/guides/{messages/queries → systems}/_category_.json +5 -5
  258. package/dist/docs/development/license-keys/_category_.json +1 -1
  259. package/dist/docs/development/license-keys/integrations.md +20 -9
  260. package/dist/docs/development/license-keys/overview.md +7 -18
  261. package/dist/docs/development/license-keys/plans.md +9 -18
  262. package/dist/docs/development/upgrading/v2.md +1 -2
  263. package/dist/docs/development/upgrading/v3.md +2 -3
  264. package/dist/docs/development/upgrading/v4.md +377 -0
  265. package/dist/docs/editor/00-overview.md +3 -3
  266. package/dist/docs/editor/01-first-edit.md +1 -1
  267. package/dist/docs/editor/explanation/markdown-mdx-git.md +1 -1
  268. package/dist/docs/editor/how-to/add-schemas-and-specifications.md +5 -5
  269. package/dist/docs/editor/how-to/edit-resource.md +1 -1
  270. package/dist/docs/editor/how-to/use-flow-editor.md +5 -5
  271. package/dist/docs/editor/how-to/use-slash-commands.md +2 -2
  272. package/dist/docs/editor/reference/supported-content.md +2 -2
  273. package/dist/docs/editor/reference/supported-resources.md +14 -14
  274. package/dist/docs/plugins/amazon-apigateway/00-intro.md +8 -8
  275. package/dist/docs/plugins/amazon-apigateway/01-installation.md +10 -12
  276. package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +5 -4
  277. package/dist/docs/plugins/apicurio/00-intro.md +8 -8
  278. package/dist/docs/plugins/apicurio/01-installation.md +12 -2
  279. package/dist/docs/plugins/apicurio/02-plugin-configuration.md +7 -9
  280. package/dist/docs/plugins/apicurio/03-features.md +2 -2
  281. package/dist/docs/plugins/asyncapi/00-intro.md +8 -8
  282. package/dist/docs/plugins/asyncapi/01-installation.md +10 -11
  283. package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +5 -5
  284. package/dist/docs/plugins/asyncapi/03-features.md +9 -9
  285. package/dist/docs/plugins/aws-glue-registry/00-intro.md +8 -8
  286. package/dist/docs/plugins/aws-glue-registry/00a-installation.md +16 -6
  287. package/dist/docs/plugins/aws-glue-registry/01-features.md +2 -2
  288. package/dist/docs/plugins/azure-schema-registry/00-intro.md +10 -10
  289. package/dist/docs/plugins/azure-schema-registry/01-installation.md +15 -5
  290. package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +4 -4
  291. package/dist/docs/plugins/azure-schema-registry/04-examples.md +1 -1
  292. package/dist/docs/plugins/backstage/00-intro.md +3 -3
  293. package/dist/docs/plugins/backstage/01-installation.md +7 -15
  294. package/dist/docs/plugins/confluent-schema-registry/00-intro.md +8 -8
  295. package/dist/docs/plugins/confluent-schema-registry/01-installation.md +12 -4
  296. package/dist/docs/plugins/confluent-schema-registry/02-plugin-configuration.md +3 -3
  297. package/dist/docs/plugins/eventbridge/00a-installation.md +21 -21
  298. package/dist/docs/plugins/eventbridge/01-features.md +3 -3
  299. package/dist/docs/plugins/eventbridge/03-api.md +5 -5
  300. package/dist/docs/plugins/eventcatalog-federation/00-introduction.md +6 -6
  301. package/dist/docs/plugins/eventcatalog-federation/01-installation.md +10 -11
  302. package/dist/docs/plugins/eventcatalog-federation/04-configuration.md +2 -2
  303. package/dist/docs/plugins/eventcatalog-federation/05-setup-team-catalog.md +5 -6
  304. package/dist/docs/plugins/github/00-intro.md +8 -8
  305. package/dist/docs/plugins/github/01-installation.md +12 -5
  306. package/dist/docs/plugins/graphql/00-intro.md +8 -8
  307. package/dist/docs/plugins/graphql/01-installation.md +11 -11
  308. package/dist/docs/plugins/graphql/02-plugin-configuration.md +3 -4
  309. package/dist/docs/plugins/graphql/03-features.md +4 -4
  310. package/dist/docs/plugins/openapi/00-intro.md +8 -8
  311. package/dist/docs/plugins/openapi/01-installation.md +10 -11
  312. package/dist/docs/plugins/openapi/02-plugin-configuration.md +7 -6
  313. package/dist/docs/plugins/openapi/03-features.md +6 -7
  314. package/dist/docs/tutorial/01-start-here.md +75 -0
  315. package/dist/docs/tutorial/02-install-eventcatalog.md +98 -0
  316. package/dist/docs/tutorial/04-add-ownership.md +184 -0
  317. package/dist/docs/tutorial/04-create-event.md +176 -0
  318. package/dist/docs/tutorial/05-create-a-domain.md +133 -0
  319. package/dist/docs/tutorial/05-publish-event.md +82 -0
  320. package/dist/docs/tutorial/06-consume-event.md +130 -0
  321. package/dist/docs/tutorial/06-create-a-service.md +99 -0
  322. package/dist/docs/tutorial/11-visualize-your-catalog.md +105 -0
  323. package/dist/docs/tutorial/12-build-your-catalog.md +79 -0
  324. package/dist/docs/tutorial/14-next-steps.md +108 -0
  325. package/dist/docs/tutorial/_category_.json +12 -0
  326. package/dist/eventcatalog.cjs +1 -1
  327. package/dist/eventcatalog.js +5 -5
  328. package/dist/generate.cjs +1 -1
  329. package/dist/generate.js +3 -3
  330. package/dist/utils/cli-logger.cjs +1 -1
  331. package/dist/utils/cli-logger.js +2 -2
  332. package/eventcatalog/public/android-chrome-192x192.png +0 -0
  333. package/eventcatalog/public/android-chrome-512x512.png +0 -0
  334. package/eventcatalog/public/apple-touch-icon.png +0 -0
  335. package/eventcatalog/public/favicon-16x16.png +0 -0
  336. package/eventcatalog/public/favicon-32x32.png +0 -0
  337. package/eventcatalog/public/favicon-48x48.png +0 -0
  338. package/eventcatalog/public/favicon-96x96.png +0 -0
  339. package/eventcatalog/public/favicon.ico +0 -0
  340. package/eventcatalog/public/favicon.svg +8 -0
  341. package/eventcatalog/src/components/Seo.astro +5 -1
  342. package/eventcatalog/src/enterprise/auth/error.astro +3 -1
  343. package/eventcatalog/src/enterprise/auth/login.astro +3 -1
  344. package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +4 -1
  345. package/eventcatalog/src/pages/studio.astro +3 -1
  346. package/eventcatalog/src/toolkit/layouts/Layout.astro +7 -1
  347. package/package.json +3 -3
  348. package/dist/docs/api/03-domain-api.md +0 -440
  349. package/dist/docs/api/04-service-api.md +0 -414
  350. package/dist/docs/api/05-command-api.md +0 -365
  351. package/dist/docs/api/06-event-api.md +0 -364
  352. package/dist/docs/api/06-query-api.md +0 -362
  353. package/dist/docs/api/08-channel-api.md +0 -363
  354. package/dist/docs/api/09-flow-api.md +0 -446
  355. package/dist/docs/api/10-entity-api.md +0 -330
  356. package/dist/docs/api/11-data-api.md +0 -273
  357. package/dist/docs/api/12-data-product-api.md +0 -445
  358. package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md +0 -68
  359. package/dist/docs/development/components/external-diagram-embeds/_category_.json +0 -12
  360. package/dist/docs/development/customization/custom-components/00-what-is-mdx.md +0 -73
  361. package/dist/docs/development/customization/custom-components/01-introduction.md +0 -28
  362. package/dist/docs/development/customization/custom-components/02-adding-components.md +0 -145
  363. package/dist/docs/development/customization/custom-components/03-component-styling.md +0 -27
  364. package/dist/docs/development/customization/custom-components/04-javascript-components.md +0 -32
  365. package/dist/docs/development/customization/custom-components/_category_.json +0 -11
  366. package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md +0 -85
  367. package/dist/docs/development/customization/customize-sidebars/_category_.json +0 -11
  368. package/dist/docs/development/developer-tools/github-action.md +0 -147
  369. package/dist/docs/development/guides/12-customize-your-sidebar.md +0 -12
  370. package/dist/docs/development/guides/agents/02-adding-agents.md +0 -152
  371. package/dist/docs/development/guides/agents/adding-to-agents/_category_.json +0 -10
  372. package/dist/docs/development/guides/agents/ownership/01-owners.md +0 -67
  373. package/dist/docs/development/guides/agents/ownership/_category_.json +0 -11
  374. package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md +0 -48
  375. package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md +0 -40
  376. package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md +0 -41
  377. package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json +0 -11
  378. package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md +0 -44
  379. package/dist/docs/development/guides/channels/ownership-and-components/02-components.md +0 -16
  380. package/dist/docs/development/guides/channels/ownership-and-components/_category_.json +0 -11
  381. package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md +0 -31
  382. package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md +0 -56
  383. package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json +0 -11
  384. package/dist/docs/development/guides/data/01-introduction.md +0 -34
  385. package/dist/docs/development/guides/data/02-adding-data.md +0 -86
  386. package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md +0 -73
  387. package/dist/docs/development/guides/data/ownership-and-components/01-owners.md +0 -45
  388. package/dist/docs/development/guides/data/ownership-and-components/02-components.md +0 -17
  389. package/dist/docs/development/guides/data/ownership-and-components/_category_.json +0 -11
  390. package/dist/docs/development/guides/data/versioning-and-lifecycle/01-versioning.md +0 -32
  391. package/dist/docs/development/guides/data/versioning-and-lifecycle/02-changelog.md +0 -57
  392. package/dist/docs/development/guides/data/versioning-and-lifecycle/03-deprecating.md +0 -71
  393. package/dist/docs/development/guides/data/versioning-and-lifecycle/_category_.json +0 -11
  394. package/dist/docs/development/guides/data-products/02-adding-data-products.md +0 -157
  395. package/dist/docs/development/guides/data-products/05-versioning.md +0 -240
  396. package/dist/docs/development/guides/data-products/06-adding-to-domains.md +0 -52
  397. package/dist/docs/development/guides/diagrams/01-introduction.md +0 -78
  398. package/dist/docs/development/guides/diagrams/02-creating-diagrams.md +0 -195
  399. package/dist/docs/development/guides/diagrams/04-versioning-diagrams.md +0 -204
  400. package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +0 -145
  401. package/dist/docs/development/guides/diagrams/06-diagrams-with-llms.md +0 -165
  402. package/dist/docs/development/guides/domains/02-creating-domains/_category_.json +0 -11
  403. package/dist/docs/development/guides/domains/04-versioning-and-changelogs/_category_.json +0 -10
  404. package/dist/docs/development/guides/domains/05-entities/01-introduction.md +0 -24
  405. package/dist/docs/development/guides/domains/05-entities/02-adding-entities.md +0 -157
  406. package/dist/docs/development/guides/domains/05-entities/03-adding-entities-to-domains.md +0 -30
  407. package/dist/docs/development/guides/domains/05-entities/04-domain-entity-map.md +0 -134
  408. package/dist/docs/development/guides/flows/01-introduction.md +0 -36
  409. package/dist/docs/development/guides/flows/02-adding-flows.md +0 -198
  410. package/dist/docs/development/guides/flows/04-adding-flows-to-services.md +0 -42
  411. package/dist/docs/development/guides/flows/05-adding-flows-to-domains.md +0 -43
  412. package/dist/docs/development/guides/flows/06-versioning.md +0 -27
  413. package/dist/docs/development/guides/flows/07-create-flow-with-ai.md +0 -171
  414. package/dist/docs/development/guides/messages/01-overview.md +0 -57
  415. package/dist/docs/development/guides/messages/_category_.json +0 -11
  416. package/dist/docs/development/guides/messages/commands/02-adding-commands.md +0 -131
  417. package/dist/docs/development/guides/messages/commands/_category_.json +0 -11
  418. package/dist/docs/development/guides/messages/common/01-map-to-producers-and-consumers.md +0 -37
  419. package/dist/docs/development/guides/messages/common/02-adding-schemas.md +0 -58
  420. package/dist/docs/development/guides/messages/common/03-owners.md +0 -40
  421. package/dist/docs/development/guides/messages/common/07-components.md +0 -12
  422. package/dist/docs/development/guides/messages/common/08-shared-messages-across-boundaries.md +0 -70
  423. package/dist/docs/development/guides/messages/common/_category_.json +0 -11
  424. package/dist/docs/development/guides/messages/events/02-adding-events.md +0 -130
  425. package/dist/docs/development/guides/messages/events/_category_.json +0 -11
  426. package/dist/docs/development/guides/messages/queries/01-introduction.md +0 -25
  427. package/dist/docs/development/guides/messages/queries/02-adding-queries.md +0 -130
  428. package/dist/docs/development/guides/owners/teams/01-introduction.md +0 -21
  429. package/dist/docs/development/guides/owners/teams/02-adding-teams.md +0 -73
  430. package/dist/docs/development/guides/owners/teams/_category_.json +0 -11
  431. package/dist/docs/development/guides/owners/users/01-introduction.md +0 -20
  432. package/dist/docs/development/guides/owners/users/02-adding-users.md +0 -69
  433. package/dist/docs/development/guides/owners/users/_category_.json +0 -11
  434. package/dist/docs/development/guides/schemas/01-introduction.md +0 -64
  435. package/dist/docs/development/guides/services/01-introduction.md +0 -33
  436. package/dist/docs/development/guides/services/02-adding-services.md +0 -113
  437. package/dist/docs/development/guides/services/03-creating-external-systems.md +0 -71
  438. package/dist/docs/development/guides/services/adding-to-services/01-messages.md +0 -229
  439. package/dist/docs/development/guides/services/adding-to-services/02-datastores.md +0 -77
  440. package/dist/docs/development/guides/services/adding-to-services/_category_.json +0 -10
  441. package/dist/docs/development/guides/services/ownership-and-components/_category_.json +0 -11
  442. package/dist/docs/development/guides/services/versioning-and-lifecycle/_category_.json +0 -11
  443. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/01-introduction.md +0 -0
  444. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/02-installation.md +0 -0
  445. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/01-introduction.md +0 -0
  446. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/02-slack-app-setup.md +0 -0
  447. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/04-deployment.md +0 -0
  448. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/05-usage.md +0 -0
  449. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/06-troubleshooting.md +0 -0
  450. /package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/09-configuration +0 -0
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(analytics_exports);
36
36
  var import_os = __toESM(require("os"), 1);
37
37
 
38
38
  // package.json
39
- var version = "4.1.3";
39
+ var version = "4.1.5";
40
40
 
41
41
  // src/constants.ts
42
42
  var VERSION = version;
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  raiseEvent
3
- } from "../chunk-PDQER3NQ.js";
4
- import "../chunk-G3D7IZ67.js";
3
+ } from "../chunk-GIU3S4CI.js";
4
+ import "../chunk-X77TET65.js";
5
5
  export {
6
6
  raiseEvent
7
7
  };
@@ -140,7 +140,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
140
140
  var import_os = __toESM(require("os"), 1);
141
141
 
142
142
  // package.json
143
- var version = "4.1.3";
143
+ var version = "4.1.5";
144
144
 
145
145
  // src/constants.ts
146
146
  var VERSION = version;
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  log_build_default
3
- } from "../chunk-DDGOJV25.js";
4
- import "../chunk-PDQER3NQ.js";
3
+ } from "../chunk-DIUAURE2.js";
4
+ import "../chunk-GIU3S4CI.js";
5
5
  import "../chunk-K2XIENVT.js";
6
- import "../chunk-G3D7IZ67.js";
6
+ import "../chunk-X77TET65.js";
7
7
  import "../chunk-6QENHZZP.js";
8
8
  export {
9
9
  log_build_default as default
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  raiseEvent
3
- } from "./chunk-PDQER3NQ.js";
3
+ } from "./chunk-GIU3S4CI.js";
4
4
  import {
5
5
  countResources,
6
6
  serializeCounts
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  logger
3
- } from "./chunk-TUKKXNQR.js";
3
+ } from "./chunk-G74MXXTG.js";
4
4
  import {
5
5
  cleanup,
6
6
  getEventCatalogConfigFile
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-G3D7IZ67.js";
3
+ } from "./chunk-X77TET65.js";
4
4
 
5
5
  // src/utils/cli-logger.ts
6
6
  import pc from "picocolors";
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-G3D7IZ67.js";
3
+ } from "./chunk-X77TET65.js";
4
4
 
5
5
  // src/analytics/analytics.js
6
6
  import os from "os";
@@ -1,5 +1,5 @@
1
1
  // package.json
2
- var version = "4.1.3";
2
+ var version = "4.1.5";
3
3
 
4
4
  // src/constants.ts
5
5
  var VERSION = version;
@@ -25,7 +25,7 @@ __export(constants_exports, {
25
25
  module.exports = __toCommonJS(constants_exports);
26
26
 
27
27
  // package.json
28
- var version = "4.1.3";
28
+ var version = "4.1.5";
29
29
 
30
30
  // src/constants.ts
31
31
  var VERSION = version;
package/dist/constants.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-G3D7IZ67.js";
3
+ } from "./chunk-X77TET65.js";
4
4
  export {
5
5
  VERSION
6
6
  };
@@ -273,7 +273,7 @@ Configure the landing page URL your EventCatalog loads. By default EventCatalog
273
273
 
274
274
  Clicking on the EventCatalog logo (or [your custom logo](/docs/api/config#logo)), will also go to this URL.
275
275
 
276
- If you set this value the `Home` icon in the vertical navigation will not be shown and your users will be redirected to this default URL.
276
+ If you set this value the `Home` icon in the Application sidebar will not be shown and your users will be redirected to this default URL.
277
277
 
278
278
  You can set this to any EventCatalog page URL.
279
279
 
@@ -289,26 +289,147 @@ module.exports = {
289
289
  };
290
290
  ```
291
291
 
292
- ### `sidebar` {#sidebar}
292
+ ### `navigation` {#navigation}
293
293
 
294
- <AddedIn version="2.30.1" />
294
+ <AddedIn version="4.0" />
295
295
 
296
- - Type: `Array[{ id: string, visible: boolean }]`
296
+ - Type: `object`
297
+
298
+ Configure navigation in EventCatalog.
297
299
 
298
- Configure the [application sidebar](/docs/development/customization/customize-sidebars/application-sidebar) in EventCatalog.
300
+ Use `navigation.groups` to configure the [Application sidebar](/docs/development/customization/application-sidebar).
299
301
 
300
- Show/hide items in the sidebar, [see list of options](/docs/development/customization/customize-sidebars/application-sidebar#showhide-items-in-the-application-sidebar).
302
+ Use `navigation.pages` to configure the [Documentation sidebar](/docs/development/customization/documentation-sidebar) shown on `/docs/*` pages.
301
303
 
302
304
  ```js title="eventcatalog.config.js"
303
305
  module.exports = {
304
- sidebar: {
305
- // Will hide the AI chat feature in the sidebar
306
- id: '/chat',
307
- visible: false
308
- }
306
+ navigation: {
307
+ groups: [
308
+ {
309
+ id: 'main',
310
+ items: [{ id: 'home' }, { id: 'docs' }],
311
+ },
312
+ {
313
+ id: 'browse',
314
+ label: 'Browse',
315
+ items: [
316
+ { id: 'catalog' },
317
+ { id: 'schemas' },
318
+ { id: 'schema-insights', visible: false },
319
+ ],
320
+ },
321
+ {
322
+ id: 'organization',
323
+ label: 'Organization',
324
+ items: [{ id: 'teams' }, { id: 'users' }],
325
+ },
326
+ {
327
+ id: 'settings',
328
+ position: 'bottom',
329
+ items: [{ id: 'settings' }],
330
+ },
331
+ ],
332
+ pages: ['list:top-level-domains', 'list:all'],
333
+ },
334
+ };
335
+ ```
336
+
337
+ #### `navigation.groups`
338
+
339
+ `navigation.groups` configures the Application sidebar that appears across EventCatalog.
340
+
341
+ If you do not configure `navigation.groups`, EventCatalog renders the default Application sidebar.
342
+
343
+ If you do configure `navigation.groups`, your groups replace the default Application sidebar. Add every item you want users to see.
344
+
345
+ Built-in Application sidebar item IDs include:
346
+
347
+ - `home`
348
+ - `docs`
349
+ - `catalog`
350
+ - `schemas`
351
+ - `schema-insights`
352
+ - `teams`
353
+ - `users`
354
+ - `settings`
355
+
356
+ You can also reference built-in route IDs directly, such as `/schemas/explorer`, `/directory/teams`, or `/settings/general`.
357
+
358
+ Groups support:
359
+
360
+ | Property | Type | Description |
361
+ | --- | --- | --- |
362
+ | `id` | `string` | Unique group identifier. |
363
+ | `label` | `string` | Optional label shown above the group. |
364
+ | `visible` | `boolean` | Set to `false` to hide the group. |
365
+ | `position` | `'top' \| 'bottom'` | Use `bottom` for groups pinned below the main navigation. Defaults to `top`. |
366
+ | `items` | `array` | Navigation items in this group. |
367
+
368
+ Items support:
369
+
370
+ | Property | Type | Description |
371
+ | --- | --- | --- |
372
+ | `id` | `string` | Built-in item id, route id, or custom item id. |
373
+ | `label` | `string` | Custom label. Required for custom items. |
374
+ | `icon` | `string` | Any icon exported by [lucide-react](https://lucide.dev/icons/), such as `House`, `BookOpen`, or `LifeBuoy`. |
375
+ | `href` | `string` | Required for custom items. Built-in items provide their own `href`. |
376
+ | `visible` | `boolean` | Set to `false` to hide the item. |
377
+ | `match` | `string \| string[]` | Paths that should mark the item as active. Useful for custom navigation items. |
378
+
379
+ ```js title="eventcatalog.config.js"
380
+ module.exports = {
381
+ navigation: {
382
+ groups: [
383
+ {
384
+ id: 'platform',
385
+ label: 'Platform',
386
+ items: [
387
+ {
388
+ id: 'platform-docs',
389
+ label: 'Platform Docs',
390
+ icon: 'BookOpen',
391
+ href: '/docs/custom/platform/overview',
392
+ match: ['/docs/custom/platform'],
393
+ },
394
+ {
395
+ id: 'support',
396
+ label: 'Support',
397
+ icon: 'LifeBuoy',
398
+ href: 'https://support.example.com',
399
+ },
400
+ ],
401
+ },
402
+ ],
403
+ },
404
+ };
405
+ ```
406
+
407
+ External `href` values open in a new tab.
408
+
409
+ #### `navigation.pages`
410
+
411
+ `navigation.pages` configures the context-aware Documentation sidebar shown on `/docs/*` pages.
412
+
413
+ ```js title="eventcatalog.config.js"
414
+ module.exports = {
415
+ navigation: {
416
+ pages: ['list:top-level-domains', 'list:all'],
417
+ },
309
418
  };
310
419
  ```
311
420
 
421
+ See [Documentation sidebar](/docs/development/customization/documentation-sidebar) for all supported list, resource, group, and custom link options.
422
+
423
+ :::note Migrating from `sidebar`
424
+
425
+ In v3 you could show or hide Application sidebar items using the top-level `sidebar` property.
426
+
427
+ In v4 this has been replaced by `navigation.groups`.
428
+
429
+ The `SideBarConfig` type is no longer exported.
430
+
431
+ :::
432
+
312
433
  ### `visualiser` {#visualiser}
313
434
 
314
435
  <AddedIn version="2.42.0" />
@@ -348,7 +469,11 @@ module.exports = {
348
469
 
349
470
  - Type: `object`
350
471
 
351
- Configure the [documentation sidebar](/docs/development/customization/customize-sidebars/documentation-sidebar) in EventCatalog.
472
+ Configure documentation rendering options in EventCatalog.
473
+
474
+ Use `docs.sidebar` for the Documentation sidebar render mode and orphaned message behavior.
475
+
476
+ Use [`navigation.pages`](#navigationpages) when you want to choose which resources, groups, and custom links appear in the [Documentation sidebar](/docs/development/customization/documentation-sidebar).
352
477
 
353
478
  ```js title="eventcatalog.config.js"
354
479
  module.exports = {
@@ -360,7 +485,7 @@ module.exports = {
360
485
  };
361
486
  ```
362
487
 
363
- Configuration for the documentation sidebar.
488
+ Configuration for the Documentation sidebar render mode.
364
489
 
365
490
  ### `docs.sidebar` options
366
491
 
@@ -704,7 +829,7 @@ Enable tools like Claude, ChatGPT, GitHub Copilot, and Cursor to quickly underst
704
829
  }
705
830
  ```
706
831
 
707
- See the [LLMs documentation](/docs/development/developer-tools/llms.txt) for more information, how you can use it and examples.
832
+ See the [LLMs documentation](/docs/development/ask-your-architecture/llms.txt) for more information, how you can use it and examples.
708
833
 
709
834
 
710
835
  ### `fullCatalogAPIEnabled` {#fullCatalogAPIEnabled}
@@ -749,6 +874,33 @@ module.exports = {
749
874
 
750
875
  See the [Customize tables](/docs/development/customization/customize-tables) documentation for more information and examples.
751
876
 
877
+ ### `systems` {#systems}
878
+
879
+ <AddedIn version="4.0" />
880
+
881
+ - Type: `object`
882
+
883
+ Configuration for the systems table.
884
+
885
+ ```js title="eventcatalog.config.js"
886
+ module.exports = {
887
+ systems: {
888
+ tableConfiguration: {
889
+ columns: {
890
+ name: { visible: true, label: 'System' },
891
+ summary: { visible: true, label: 'Summary' },
892
+ services: { visible: true, label: 'Services' },
893
+ flows: { visible: true, label: 'Flows' },
894
+ badges: { visible: true, label: 'Badges' },
895
+ actions: { visible: true, label: 'Actions' },
896
+ }
897
+ }
898
+ }
899
+ };
900
+ ```
901
+
902
+ See the [Customize tables](/docs/development/customization/customize-tables) documentation for more information and examples.
903
+
752
904
  ### `events` {#events}
753
905
 
754
906
  <AddedIn version="2.63.0" />
@@ -1,5 +1,5 @@
1
1
  ---
2
- sidebar_position: 100
2
+ sidebar_position: 6
3
3
  sidebar_label: Code blocks
4
4
  title: Code blocks
5
5
  description: Understanding what is possible with EventCatalog code blocks
@@ -8,65 +8,54 @@ title: Why EventCatalog?
8
8
  description: EventCatalog is an open source project to help you bring discoverability to your event-driven architecture.
9
9
  ---
10
10
 
11
- Many companies adopting event-driven architectures end up in a **distributed big ball of mud**.
11
+ Software architecture consists of many different primitives including domains, systems, services, APIS, contracts, messages and many more.
12
12
 
13
- There can be many reasons for this...but one overlooked reason is that teams are not documenting their architectures, they lack standards, governance and discoverability.
13
+ As systems grow, complexity grows. Documentation becomes important for teams but teams struggle to keep docs in sync, or relevant to what they are trying to model.
14
14
 
15
- Your teams start to ask questions like:
15
+ **Many documentation tools are not designed for software architecture**; they let you create generic pages that get lost across the organization, they do not stay in sync with your code, specifications and teams making changes.
16
16
 
17
- - _"What messages do we have?"_
18
- - _"How are consumers and producers using these messages?"_
19
- - _"What common fields are across our schemas? What is the drift?"_
20
- - _"What's the business context behind this architecture?"_
21
- - _"Where can I find the schemas of these messages?"_
22
- - _"What services or domains do we have in our architecture?"_
23
- - _"How can I make changes?"_
24
- - _"Who is consuming these messages?"_
25
- - _And the list goes on..._
17
+ **Our vision with EventCatalog is to change this.**
26
18
 
27
- Time is lost hunting through multiple tools to find the answers to these questions.
19
+ ### What is EventCatalog?
28
20
 
29
- **What if you could answer these questions in minutes?**
21
+ EventCatalog is a documentation and governance tool that is built for architects.
30
22
 
31
- EventCatalog is designed to help you avoid the chaos, by providing a way to document your architecture, visualize it, and provide tools to help your teams and AI tools to save time and get answers to the questions when they need them.
23
+ It lets you document and visualize your architecture with primitives you are already familiar with. You can document domains, systems, applications and schemas and visualize how they all relate to each other.
32
24
 
33
- ---
34
-
35
- ## What is EventCatalog?
25
+ EventCatalog creates an internal architecture graph of how your systems work. This makes EventCatalog accessible to your AI agents, LLMs and AI workflows and [creates context of your business and architecture](/docs/development/ask-your-architecture/intro).
36
26
 
37
- [EventCatalog is a self-hosted open source project](https://github.com/event-catalog/eventcatalog) to help you bring discoverability to your architecture through documentation, visualization, and design for both humans and AI.
27
+ EventCatalog is technology agnostic, this means you can document and model any systems you have
38
28
 
39
- EventCatalog models your architecture as structured, versioned knowledge — not just pages of documentation — so it can be searched, visualized, and queried reliably over time.
40
-
41
- **EventCatalog is technology agnostic**, you can use it and integrate with any broker, schema format, or stack.
42
29
 
43
30
  #### What can EventCatalog do for you?
44
31
 
45
- - **Save time and help your teams find answers fast**
46
- - Search your entire architecture domains, services, events, data products, schemas, owners — in seconds
47
- - Stop asking "who owns this?" or "what consumes this event?"
48
- - **Keep documentation and specifications in sync**
49
- - Auto-generate docs from your OpenAPI, AsyncAPI, or schema registries
50
- - Documentation that updates when your specs update
51
- - Write custom integrations with the [EventCatalog SDK](/docs/sdk)
52
- - **Query your architecture with AI**
32
+ - **Save time across the organization**
33
+ - Help teams find information they need across your business and organization
34
+ - Document high level information for stakeholders while providing lower level details to your teams.
35
+ - Connect to your AI Agents and AI Workflows. Give your LLMs the context they need.
36
+ - **Create documentation you can trust**
37
+ - Sync documentation from your code with our Agent
38
+ - Automate documentation from your OpenAPI, AsyncAPI, or schema registries
39
+ - Use EventCatalog Agent to sync code to docs from your CI/CD workflows.
40
+ - Write your own automation and plugins with the [EventCatalog SDK](/docs/sdk)
41
+ - **Detect breaking changes before they reach production**
42
+ - Use EventCatalog Agent to detect breaking schema changes
43
+ - Bring your own model and get notified when things break
44
+ - **Use natural langugage to query your architecture**
53
45
  - Connect AI tools to your architecture using [EventCatalog's MCP server](/docs/development/ask-your-architecture/mcp-server/introduction)
54
46
  - Ask architectural questions grounded in your documented domains, services, events, data products, and schemas
55
- - **See the bigger picture**
56
- - Visualize your architecture, domains, services, and message flows
57
- - Document business workflows and draft new ideas
58
- - Understand how everything connects — without digging through code
59
- - **Design what's next**
60
- - Capture business workflows and plan changes visually
61
- - Use your real architecture as building blocks
47
+ - **Show the bigger picture**
48
+ - Help business stakeholders understand the bigger picture
49
+ - Visualize your architecture and future ideas
50
+ - Document key business workflows
62
51
 
63
52
  **EventCatalog is self-hosted. You own your data and host it wherever you want.**
64
53
 
65
54
  ---
66
55
 
67
- ## Why we built this
56
+ <!-- ## Why we built this
68
57
 
69
- Event-driven architectures start simple but grow complex fast. More services, more events, more teams — and suddenly nobody knows how anything connects.
58
+ Distributed architecture starts simple but grow complex fast. More services, more events, more teams — and suddenly nobody knows how anything connects.
70
59
 
71
60
  EventCatalog brings discoverability, documentation, and visualization to your architecture — so teams can reason about change before it happens, not after.
72
61
 
@@ -75,7 +64,7 @@ EventCatalog brings discoverability, documentation, and visualization to your ar
75
64
  <iframe width="100%" height="415" src="https://www.youtube.com/embed/VLUvfIm9wnQ?si=XEEkOqHyZBynqZHo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
76
65
  </details>
77
66
 
78
- ---
67
+ --- -->
79
68
 
80
69
  ## Join the community
81
70
 
@@ -8,18 +8,66 @@ title: Fundamentals
8
8
  description: Understanding the fundamentals of EventCatalog
9
9
  ---
10
10
 
11
- EventCatalog allows you to document your [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [messages](/docs/development/guides/messages/overview) ([events](/docs/development/guides/messages/events/introduction), [commands](/docs/development/guides/messages/commands/introduction), [queries](/docs/development/guides/messages/queries/introduction)), [data products](/docs/development/guides/data-products/introduction), [data stores](/docs/development/guides/data/introduction), [diagrams](/docs/development/guides/diagrams/introduction), [schemas](/docs/development/guides/schemas/introduction), [specifications](/docs/development/guides/services/adding-to-services/openapi) and more.
11
+ EventCatalog is a architecture catalog built around software primitives and domain-driven design patterns, so you can model the systems you actually build instead of creating disconnected documentation pages.
12
12
 
13
- You can manually document these resources or you can automate the documentation process using EventCatalog integrations (e.g. [OpenAPI](/integrations/openapi), [AsyncAPI](/integrations/asyncapi), [GraphQL](/integrations/graphql) or schema registries), it's up to you.
13
+ EventCatalog gives your teams and AI agents a shared understanding of how your systems work across your organization.
14
14
 
15
- EventCatalog is flexible and can fit any workflow you have. Deploy it once a day, or 100 times a day. Connect it to external systems like schema registries, API management platforms, or your own custom integrations.
15
+ EventCatalog is an open source project and is self-hosted and follows the [docs-as-code](https://www.writethedocs.org/guide/docs-as-code/) pattern. All pages in EventCatalog are powered by [markdown (MDX)](https://mdxjs.com/).
16
16
 
17
- EventCatalog is powered by [markdown files (MDX)](https://mdxjs.com/) and can be used in any markdown editor or IDE.
17
+ Your catalog is private, stays in your own repository and infrastructure.
18
18
 
19
- ### Docs-as-code
19
+ At its core, EventCatalog gives you a small set of building blocks.
20
+
21
+ - **Domains (Level 1)** - a domain describes a business boundary
22
+ - **Systems (Level 2)** - a system is a collection of resources that work together to perform a function.
23
+ - **Resources (Level 3)** - individual resources (e.g services, messages, data stores) that can be assigned to systems or domains.
24
+
25
+ All building blocks are optional, it's up to you how you want to model your architecture in your catalog.
26
+
27
+ ![EventCatalog model showing domains, systems, resources, contracts, and ownership](./img/ec-types.png)
28
+
29
+ ## The EventCatalog model
30
+
31
+ Domains give your catalog a business shape. They help users understand the boundaries in your architecture, such as `Shopping`, `Payments`, `Fulfilment`, or `Customer`.
32
+
33
+ Systems give your catalog an operating shape. A system is a collection of resources that work together to perform a function. For example, a `Shopping` domain might contain a `Cart System` and a `Promotion System`.
34
+
35
+ Resources are the documented building blocks inside your architecture. They can include:
36
+
37
+ - [Services](/docs/development/guides/resources/services/introduction), such as APIs, workers, frontends, and backends.
38
+ - [Messages](/docs/development/guides/resources/messages/what-are-messages), such as events, commands, and queries.
39
+ - [Data stores](/docs/development/guides/resources/data/introduction), such as databases, caches, and file stores.
40
+ - [Entities](/docs/development/guides/resources/entities/introduction), such as `Order`, `Customer`, or `Payment`.
41
+ - [Data products](/docs/development/guides/resources/data-products/introduction), such as warehouse tables or analytical datasets.
42
+ - [Agents](/docs/development/guides/resources/agents/introduction), such as customer support AI agents.
43
+ - [Flows](/docs/development/guides/resources/flows/introduction), such as business workflows.
44
+
45
+ Contracts are attached to resources. Schemas, OpenAPI specs, AsyncAPI specs, and GraphQL schemas help users understand the data and interfaces that resources produce, consume, or implement.
46
+
47
+ Teams and users can own domains, systems, resources, and contracts. This makes ownership part of the architecture model, not a separate spreadsheet.
48
+
49
+ ## Levels of detail
50
+
51
+ EventCatalog is useful to anyone in your organization. You can define high level primitives whilst giving lower level implementation details.
52
+
53
+ | Level | Name | What it answers | Example |
54
+ |-------|------|-----------------|---------|
55
+ | Level 1 | Domains | High level, what business boundary are we looking at? | Shopping |
56
+ | Level 2 | Systems | What software capability exists inside that boundary? | Cart System |
57
+ | Level 3 | Resources | What makes up, connects to, or documents that system? | Cart API, cart database, checkout flow |
58
+
59
+ Contracts and ownership sit across these levels. A service can implement an OpenAPI contract. A message can have a schema. A team can own a domain, system, or resource.
60
+
61
+ This gives different users a way into the same catalog. Architects can start at domains, platform teams can reason about systems, and developers can drill into the resources and contracts they work with every day.
62
+
63
+ ## Docs-as-code
20
64
 
21
65
  EventCatalog is a [docs-as-code](https://www.writethedocs.org/guide/docs-as-code/) tool. This means you can store your documentation in your existing Git repository, version it, and use your existing workflows to review and merge changes.
22
66
 
67
+ This also let's you define custom workflows and patterns in your organization for documentation and automation.
68
+
69
+ It's up to you where you define your catalog (or catalogs). Here are some examples:
70
+
23
71
  | Pattern | Description |
24
72
  |---------|-------------|
25
73
  | **Standalone repo** | Keep documentation separate from code |
@@ -27,9 +75,12 @@ EventCatalog is a [docs-as-code](https://www.writethedocs.org/guide/docs-as-code
27
75
  | **Monorepo** | Documentation as part of your existing monorepo |
28
76
  | **Federated** | Multiple EventCatalog instances connected into one view |
29
77
 
30
- EventCatalog does not force you to use a specific broker, schema format, or stack. You can use it with any broker, schema format, or stack and can fit into any workflow you have. EventCatalog fits your workflow, not the other way around.
31
78
 
32
- ### Visual editing
79
+ ## Automation
80
+
81
+ Your documentation can also be automated, keeping your implementation details close to your documentation. There are many [integrations](/integrations) or you can create your own automations with our [SDK](/docs/sdk).
82
+
83
+ ## Visual editing
33
84
 
34
85
  You can also use [EventCatalog Editor](/docs/editor/overview) to maintain your catalog through a local visual workflow.
35
86
 
@@ -11,84 +11,10 @@ import AddedIn from '@site/src/components/MDX/AddedIn';
11
11
 
12
12
  Most new EventCatalog projects are ready to run as soon as they are created. You only need to change configuration when you want to adjust how the catalog behaves, where it builds, or which features are enabled.
13
13
 
14
- Configuration lives in `eventcatalog.config.js` at the root of your project.
15
-
16
- Use this file for catalog-level settings, such as the catalog title, organization name, build output, deployment path, and integrations.
17
-
18
- ## Start with the generated config
19
-
20
- When you create a new EventCatalog project, the starter creates an `eventcatalog.config.js` file for you. For many catalogs, you can leave this file alone while you create your first domains, services, and messages.
21
-
22
- Your config may look something like this:
23
-
24
- ```js title="eventcatalog.config.js"
25
- module.exports = {
26
- cId: '107fdebb-7c68-42cc-975d-413b1d30d758',
27
- title: 'EventCatalog',
28
- organizationName: 'Your Company',
29
- };
30
- ```
31
-
32
- - `cId` is generated for your catalog. Keep the generated value.
33
- - `title` is the name shown in your catalog.
34
- - `organizationName` identifies the team or company that owns the catalog.
35
-
36
- ## Common changes
37
-
38
- You do not need to learn every configuration option up front. These are the settings most teams change first:
39
-
40
- The examples below show only the option being changed. Keep the other values that already exist in your config.
41
-
42
- ### Change the catalog name
43
-
44
- ```js title="eventcatalog.config.js"
45
- module.exports = {
46
- title: 'Acme Architecture Catalog',
47
- organizationName: 'Acme',
48
- };
49
- ```
50
-
51
- ### Change the build output
52
-
53
- By default, EventCatalog builds a static website that can be hosted almost anywhere.
54
-
55
- Some features require EventCatalog to run as a server. You can switch the build output with the `output` option.
56
-
57
- ```js title="eventcatalog.config.js"
58
- module.exports = {
59
- output: 'server',
60
- };
61
- ```
62
-
63
- Learn more about build output in the [configuration API](/docs/api/config#output).
64
-
65
- ### Configure a deployment base path
66
-
67
- If your catalog is hosted under a sub-path, configure `base`.
68
-
69
- ```js title="eventcatalog.config.js"
70
- module.exports = {
71
- base: '/architecture/',
72
- };
73
- ```
74
-
75
- For a catalog hosted at the root of a domain, keep the default `/`.
76
-
77
- ## Full configuration reference
78
-
79
- This page only covers the basics. When you need the complete list of options, use the [eventcatalog.config.js API reference](/docs/api/config).
80
-
81
- Configuration guides for specific features live near the feature they configure. For example:
82
-
83
- - [Adding Analytics](/docs/development/guides/adding-analytics)
84
- - [RSS feeds](/docs/api/config#rss)
85
- - [Authentication](/docs/development/authentication/introduction)
86
- - [Deployment](/docs/development/deployment/build-and-deploy)
14
+ Configuration lives in `eventcatalog.config.js` at the root of your project. You can read the [full reference documentation](/docs/api/config) to learn what can be changed.
87
15
 
88
16
  ## Configuring environment variables {#configuring-environment-variables}
89
17
 
90
- <AddedIn version="2.35.4" />
91
-
92
18
  Some features need values that should not live directly in `eventcatalog.config.js`, such as license keys or provider credentials.
93
19
 
94
20
  Put those values in a `.env` file in the root of your catalog. EventCatalog loads `.env` when it runs locally and when it builds.
@@ -104,21 +30,3 @@ Do not commit real secrets to source control.
104
30
  EventCatalog has a linter that can be used to validate your EventCatalog documentation.
105
31
 
106
32
  You can read more about the EventCatalog Linter in the [EventCatalog Linter documentation](/docs/development/developer-tools/eventcatalog-linter).
107
-
108
- ### Advanced: disable channel migration
109
-
110
- On startup, EventCatalog automatically migrates legacy `channels` definitions on messages to the service-level channels shape.
111
-
112
- Most new catalogs do not need to change this behavior. If you are working with an older catalog and want to leave legacy channel definitions untouched, set `EVENTCATALOG_DISABLE_CHANNEL_MIGRATION`.
113
-
114
- **Accepted values:** `true`, `1`, or `yes` (case-insensitive). Any other value, or leaving the variable unset, keeps the default behavior: the migration runs as normal.
115
-
116
- ```bash
117
- EVENTCATALOG_DISABLE_CHANNEL_MIGRATION=true npx @eventcatalog/core dev
118
- ```
119
-
120
- You can also set it in your `.env` file:
121
-
122
- ```bash title=".env"
123
- EVENTCATALOG_DISABLE_CHANNEL_MIGRATION=true
124
- ```