@eventcatalog/core 4.1.2 → 4.1.4

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 (440) hide show
  1. package/dist/analytics/analytics.cjs +1 -1
  2. package/dist/analytics/analytics.js +2 -2
  3. package/dist/analytics/count-resources.cjs +8 -2
  4. package/dist/analytics/count-resources.js +1 -1
  5. package/dist/analytics/log-build.cjs +12 -4
  6. package/dist/analytics/log-build.js +4 -4
  7. package/dist/{chunk-2HP7DWTG.js → chunk-B3HQOT3D.js} +1 -1
  8. package/dist/{chunk-6MLMZ7C6.js → chunk-CAYWT7E4.js} +1 -1
  9. package/dist/{chunk-DAOXTQVS.js → chunk-K2XIENVT.js} +8 -2
  10. package/dist/{chunk-XDI5KMKL.js → chunk-RAB6LGHN.js} +5 -3
  11. package/dist/{chunk-BAPUZSRK.js → chunk-TCK7WEEE.js} +1 -1
  12. package/dist/{chunk-UKC6BKFK.js → chunk-ZLQUICJD.js} +1 -1
  13. package/dist/constants.cjs +1 -1
  14. package/dist/constants.js +1 -1
  15. package/dist/docs/api/02-config.md +166 -14
  16. package/dist/docs/api/08-code-blocks.md +1 -1
  17. package/dist/docs/development/00-why-eventcatalog.md +29 -40
  18. package/dist/docs/development/01-fundamentals.md +58 -7
  19. package/dist/docs/development/01-getting-started/configuration-overview.md +1 -93
  20. package/dist/docs/development/01-getting-started/develop-and-build.md +4 -3
  21. package/dist/docs/development/01-getting-started/installation.md +3 -3
  22. package/dist/docs/development/01-getting-started/project-structure.md +74 -141
  23. package/dist/docs/development/ask-your-architecture/01-intro.md +8 -76
  24. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +4 -3
  25. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +2 -1
  26. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +1 -3
  27. package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +2 -2
  28. package/dist/docs/development/{developer-tools/llms.txt.md → ask-your-architecture/02-llms.txt.md} +1 -2
  29. package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +2 -2
  30. package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +2 -2
  31. package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +2 -25
  32. package/dist/docs/development/{developer-tools/schemas.txt.md → ask-your-architecture/03-schemas.txt.md} +1 -2
  33. package/dist/docs/development/ask-your-architecture/04-agents/01-overview.md +27 -0
  34. package/dist/docs/development/ask-your-architecture/04-agents/02-code-to-docs.md +124 -0
  35. package/dist/docs/development/ask-your-architecture/04-agents/03-breaking-changes.md +170 -0
  36. package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +12 -0
  37. package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/_category_.json +2 -2
  38. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/03-installation.md +1 -1
  39. package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/_category_.json +2 -1
  40. package/dist/docs/development/ask-your-architecture/_category_.json +2 -2
  41. package/dist/docs/development/authentication/01-introduction.md +3 -3
  42. package/dist/docs/development/authentication/02-enabling-authentication.md +2 -2
  43. package/dist/docs/development/authentication/providers/03-setting-up-github.md +25 -1
  44. package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -1
  45. package/dist/docs/development/bring-your-own-documentation/01-introduction.md +29 -25
  46. package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +9 -8
  47. package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +70 -32
  48. package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +4 -1
  49. package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +2 -1
  50. package/dist/docs/development/bring-your-own-documentation/custom-pages/_category_.json +1 -1
  51. package/dist/docs/development/bring-your-own-documentation/diagrams/01-introduction.md +56 -0
  52. package/dist/docs/development/bring-your-own-documentation/diagrams/02-creating-diagrams.md +262 -0
  53. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/03-referencing-diagrams.md +3 -87
  54. package/dist/docs/development/bring-your-own-documentation/diagrams/05-comparing-diagrams.md +25 -0
  55. package/dist/docs/development/bring-your-own-documentation/diagrams/07-reference.md +144 -0
  56. package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/_category_.json +2 -1
  57. package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +2 -4
  58. package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +138 -43
  59. package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +38 -9
  60. package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +62 -13
  61. package/dist/docs/development/components/04-snippets.md +0 -2
  62. package/dist/docs/development/components/05-using-components.md +4 -16
  63. package/dist/docs/development/components/07-resource-references.md +1 -1
  64. package/dist/docs/development/components/_category_.json +3 -3
  65. package/dist/docs/development/components/components/01-accordian.md +1 -1
  66. package/dist/docs/development/components/components/03-admonitions.md +1 -1
  67. package/dist/docs/development/components/components/04-agent-tools.md +2 -2
  68. package/dist/docs/development/components/components/05-attachments.md +1 -1
  69. package/dist/docs/development/components/components/07-design.md +1 -2
  70. package/dist/docs/development/components/components/08-entitymap.md +2 -2
  71. package/dist/docs/development/components/components/09-flow.md +1 -1
  72. package/dist/docs/development/components/components/10-link.md +1 -1
  73. package/dist/docs/development/components/components/11-mermaid-file-loader.md +1 -1
  74. package/dist/docs/development/components/components/12-message-table.md +1 -1
  75. package/dist/docs/development/components/components/13-nodegraph.md +1 -1
  76. package/dist/docs/development/components/components/14-openapi.md +3 -3
  77. package/dist/docs/development/components/components/15-prompt.md +2 -6
  78. package/dist/docs/development/components/components/16-remote-schema.md +5 -3
  79. package/dist/docs/development/components/components/17-resource-group-table.md +1 -1
  80. package/dist/docs/development/components/components/18-resource-link.md +1 -1
  81. package/dist/docs/development/components/components/19-schema.md +1 -1
  82. package/dist/docs/development/components/components/20-schema-viewer.md +1 -1
  83. package/dist/docs/development/components/components/21-steps.md +1 -1
  84. package/dist/docs/development/components/components/22-tabs.md +1 -1
  85. package/dist/docs/development/components/components/23-tiles.md +1 -1
  86. package/dist/docs/development/components/components/24-visibility.md +1 -1
  87. package/dist/docs/development/components/components/_category_.json +1 -1
  88. package/dist/docs/development/components/custom-components/01-introduction.md +74 -0
  89. package/dist/docs/development/components/custom-components/02-create-your-first-component.md +71 -0
  90. package/dist/docs/development/components/custom-components/03-pass-data-into-components.md +86 -0
  91. package/dist/docs/development/components/custom-components/04-fetch-data-in-components.md +191 -0
  92. package/dist/docs/development/components/custom-components/05-style-components.md +60 -0
  93. package/dist/docs/development/components/custom-components/06-add-client-side-scripts.md +67 -0
  94. package/dist/docs/development/components/custom-components/07-reference.md +115 -0
  95. package/dist/docs/development/components/custom-components/_category_.json +11 -0
  96. package/dist/docs/development/components/{external-diagram-embeds/03-drawio.md → diagram-syntax/01-drawio.md} +2 -3
  97. package/dist/docs/development/components/{external-diagram-embeds/04-figjam.md → diagram-syntax/02-figjam.md} +1 -2
  98. package/dist/docs/development/components/diagram-syntax/{04-icepanel.md → 03-icepanel.md} +1 -2
  99. package/dist/docs/development/components/diagram-syntax/04-likec4.md +136 -0
  100. package/dist/docs/development/components/{external-diagram-embeds/02-lucid.md → diagram-syntax/05-lucid.md} +2 -3
  101. package/dist/docs/development/components/diagram-syntax/{01-mermaid.md → 06-mermaid.md} +1 -1
  102. package/dist/docs/development/components/{external-diagram-embeds/01-miro.md → diagram-syntax/07-miro.md} +2 -3
  103. package/dist/docs/development/components/diagram-syntax/{02-plantuml.md → 08-plantuml.md} +3 -3
  104. package/dist/docs/development/components/diagram-syntax/{03-structurizr.md → 09-structurizr.md} +1 -1
  105. package/dist/docs/development/components/diagram-syntax/_category_.json +3 -3
  106. package/dist/docs/development/customization/01-customize-landing-page.md +7 -15
  107. package/dist/docs/development/customization/02-themes.md +1 -0
  108. package/dist/docs/development/customization/03-application-sidebar.md +246 -0
  109. package/dist/docs/development/customization/03-search.md +2 -2
  110. package/dist/docs/development/customization/{customize-sidebars/01-documentation-sidebar.md → 04-documentation-sidebar.md} +4 -4
  111. package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +94 -0
  112. package/dist/docs/development/customization/05-custom-pages-and-api-routes/02-create-a-custom-page.md +177 -0
  113. package/dist/docs/development/customization/05-custom-pages-and-api-routes/03-create-an-api-route.md +128 -0
  114. package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +138 -0
  115. package/dist/docs/development/customization/05-custom-pages-and-api-routes/_category_.json +12 -0
  116. package/dist/docs/development/customization/06-customize-tables.md +3 -3
  117. package/dist/docs/development/customization/07-resource-icons.md +190 -0
  118. package/dist/docs/development/customization/_category_.json +1 -1
  119. package/dist/docs/development/customization/customize-visualizer/_category_.json +2 -2
  120. package/dist/docs/development/deployment/hosting-options.md +1 -2
  121. package/dist/docs/development/developer-tools/api-catalog.md +1 -1
  122. package/dist/docs/development/developer-tools/eventcatalog-linter.md +137 -2
  123. package/dist/docs/development/governance/_category_.json +1 -0
  124. package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +2 -2
  125. package/dist/docs/development/guides/98-versioning-resources.md +192 -0
  126. package/dist/docs/development/guides/99-adding-analytics.md +0 -1
  127. package/dist/docs/development/guides/changelogs/02-adding-changelogs.md +2 -2
  128. package/dist/docs/development/guides/changelogs/03-automated-changelogs.md +2 -2
  129. package/dist/docs/development/guides/changelogs/04-reference.md +77 -0
  130. package/dist/docs/development/guides/changelogs/_category_.json +2 -2
  131. package/dist/docs/development/guides/domains/01-introduction.md +14 -9
  132. package/dist/docs/development/guides/domains/{02-creating-domains/02-adding-domains.md → 02-create-domain.md} +32 -16
  133. package/dist/docs/development/guides/domains/{02-creating-domains/02a-subdomains.md → 03-model-subdomains.md} +22 -10
  134. package/dist/docs/development/guides/domains/03-ownership-and-language/01-owners.md +1 -1
  135. package/dist/docs/development/guides/domains/03-ownership-and-language/02-adding-ubiquitous-language.md +2 -6
  136. package/dist/docs/development/guides/domains/03-ownership-and-language/_category_.json +2 -2
  137. package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +154 -0
  138. 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
  139. 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
  140. 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
  141. package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +115 -0
  142. package/dist/docs/development/guides/domains/04-add-resources-to-domains/_category_.json +11 -0
  143. package/dist/docs/development/guides/domains/{08-domain-integration-map.md → 06-visualize-domains/01-domain-integration-map.md} +5 -6
  144. package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +12 -0
  145. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/01-versioning.md → 07-version-domains.md} +5 -6
  146. package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/02-changelog.md → 08-add-changelog.md} +6 -7
  147. package/dist/docs/development/guides/domains/09-reference.md +517 -0
  148. package/dist/docs/development/guides/owners/01-what-are-teams-and-users.md +46 -0
  149. package/dist/docs/development/guides/owners/02-create-team.md +110 -0
  150. package/dist/docs/development/guides/owners/03-create-user.md +99 -0
  151. package/dist/docs/development/guides/owners/05-teams-reference.md +144 -0
  152. package/dist/docs/development/guides/owners/06-users-reference.md +128 -0
  153. package/dist/docs/development/guides/owners/_category_.json +2 -2
  154. package/dist/docs/development/guides/owners/automated-teams-and-users/_category_.json +11 -0
  155. package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +108 -0
  156. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +156 -0
  157. package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +253 -0
  158. package/dist/docs/development/guides/resources/_category_.json +11 -0
  159. package/dist/docs/development/guides/resources/adrs/01-introduction.md +37 -0
  160. package/dist/docs/development/guides/resources/adrs/02-creating-adrs.md +211 -0
  161. package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +52 -0
  162. package/dist/docs/development/guides/resources/adrs/04-relationships.md +80 -0
  163. package/dist/docs/development/guides/resources/adrs/06-reference.md +247 -0
  164. package/dist/docs/development/guides/resources/adrs/_category_.json +11 -0
  165. package/dist/docs/development/guides/{agents → resources/agents}/01-introduction.md +1 -16
  166. package/dist/docs/development/guides/resources/agents/02-create-agent.md +188 -0
  167. package/dist/docs/development/guides/{agents → resources/agents}/03-adding-tools.md +3 -4
  168. package/dist/docs/development/guides/{agents → resources/agents}/04-model-metadata.md +2 -2
  169. package/dist/docs/development/guides/{agents/adding-to-agents/01-messages.md → resources/agents/05-add-messages-to-agents.md} +5 -4
  170. package/dist/docs/development/guides/{agents/adding-to-agents/02-datastores.md → resources/agents/06-add-data-stores-to-agents.md} +4 -15
  171. package/dist/docs/development/guides/resources/agents/11-reference.md +238 -0
  172. package/dist/docs/development/guides/{agents → resources/agents}/_category_.json +2 -2
  173. package/dist/docs/development/guides/resources/data/01-introduction.md +15 -0
  174. package/dist/docs/development/guides/resources/data/02-adding-data.md +184 -0
  175. package/dist/docs/development/guides/resources/data/03-add-read-write-relationships.md +128 -0
  176. package/dist/docs/development/guides/resources/data/04-reference.md +211 -0
  177. package/dist/docs/development/guides/{data → resources/data}/_category_.json +3 -3
  178. package/dist/docs/development/guides/{data-products → resources/data-products}/01-introduction.md +1 -17
  179. package/dist/docs/development/guides/resources/data-products/02-adding-data-products.md +174 -0
  180. package/dist/docs/development/guides/{data-products → resources/data-products}/03-inputs-and-outputs.md +4 -6
  181. package/dist/docs/development/guides/{data-products → resources/data-products}/04-contracts.md +2 -4
  182. package/dist/docs/development/guides/resources/data-products/07-reference.md +201 -0
  183. package/dist/docs/development/guides/{data-products → resources/data-products}/_category_.json +3 -3
  184. package/dist/docs/development/guides/resources/entities/01-introduction.md +26 -0
  185. package/dist/docs/development/guides/resources/entities/02-create-entity.md +162 -0
  186. package/dist/docs/development/guides/resources/entities/03-model-entity-relationships.md +115 -0
  187. package/dist/docs/development/guides/resources/entities/04-add-entities-to-resources.md +188 -0
  188. package/dist/docs/development/guides/resources/entities/05-entity-maps.md +48 -0
  189. package/dist/docs/development/guides/resources/entities/06-reference.md +273 -0
  190. package/dist/docs/development/guides/{domains/05-entities → resources/entities}/_category_.json +4 -4
  191. package/dist/docs/development/guides/resources/flows/01-introduction.md +28 -0
  192. package/dist/docs/development/guides/resources/flows/02-create-flow.md +304 -0
  193. package/dist/docs/development/guides/{flows/03-flow-nodes.md → resources/flows/03-model-flow-steps.md} +6 -6
  194. package/dist/docs/development/guides/resources/flows/04-add-flows-to-resources.md +149 -0
  195. package/dist/docs/development/guides/resources/flows/06-reference.md +226 -0
  196. package/dist/docs/development/guides/{flows → resources/flows}/_category_.json +3 -3
  197. package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +104 -0
  198. package/dist/docs/development/guides/{messages/events/01-introduction.md → resources/messages/02-message-types/01-events.md} +3 -7
  199. package/dist/docs/development/guides/{messages/commands/01-introduction.md → resources/messages/02-message-types/02-commands.md} +4 -7
  200. package/dist/docs/development/guides/resources/messages/02-message-types/03-queries.md +20 -0
  201. package/dist/docs/development/guides/resources/messages/02-message-types/_category_.json +11 -0
  202. package/dist/docs/development/guides/resources/messages/03-create-messages/01-create-event.md +137 -0
  203. package/dist/docs/development/guides/resources/messages/03-create-messages/02-create-command.md +156 -0
  204. package/dist/docs/development/guides/resources/messages/03-create-messages/03-create-query.md +158 -0
  205. package/dist/docs/development/guides/{messages/common/02-draft-messages.md → resources/messages/03-create-messages/04-create-draft-message.md} +5 -7
  206. package/dist/docs/development/guides/resources/messages/03-create-messages/_category_.json +11 -0
  207. package/dist/docs/development/guides/resources/messages/04-connect-messages/01-map-producers-and-consumers.md +32 -0
  208. package/dist/docs/development/guides/resources/messages/04-connect-messages/02-shared-messages-across-boundaries.md +170 -0
  209. package/dist/docs/development/guides/{messages/common/09-grouping-messages.md → resources/messages/04-connect-messages/03-group-messages.md} +2 -4
  210. package/dist/docs/development/guides/resources/messages/04-connect-messages/_category_.json +11 -0
  211. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/01-introduction.md +4 -28
  212. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/02-adding-channels.md +77 -62
  213. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/04-adding-messages-to-services.md +10 -14
  214. package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +177 -0
  215. package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/_category_.json +3 -3
  216. package/dist/docs/development/guides/{messages/common/04-versioning.md → resources/messages/08-versioning-and-lifecycle/01-version-messages.md} +39 -4
  217. package/dist/docs/development/guides/{messages/common/05-changelog.md → resources/messages/08-versioning-and-lifecycle/02-add-changelog.md} +5 -6
  218. package/dist/docs/development/guides/{messages/common/02-deprecating.md → resources/messages/08-versioning-and-lifecycle/03-deprecate-messages.md} +4 -4
  219. package/dist/docs/development/guides/resources/messages/08-versioning-and-lifecycle/_category_.json +11 -0
  220. package/dist/docs/development/guides/{messages/common/02-examples.md → resources/messages/09-add-usage-examples.md} +59 -22
  221. package/dist/docs/development/guides/resources/messages/10-reference.md +439 -0
  222. package/dist/docs/development/guides/resources/messages/_category_.json +11 -0
  223. package/dist/docs/development/guides/resources/schemas/01-what-are-schemas-and-specifications.md +25 -0
  224. package/dist/docs/development/guides/resources/schemas/02-add-schemas-to-messages.md +63 -0
  225. package/dist/docs/development/guides/resources/schemas/03-add-schemas-to-data-stores.md +90 -0
  226. 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
  227. 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
  228. 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
  229. package/dist/docs/development/guides/resources/schemas/03-add-specifications-to-services/_category_.json +11 -0
  230. package/dist/docs/development/guides/{schemas/02-schema-explorer.md → resources/schemas/04-explore-schemas/01-schema-explorer.md} +3 -26
  231. package/dist/docs/development/guides/{schemas/06-fields-explorer.md → resources/schemas/04-explore-schemas/02-fields-explorer.md} +8 -10
  232. package/dist/docs/development/guides/{schemas/05-field-usage.md → resources/schemas/04-explore-schemas/03-consumer-field-usage.md} +1 -3
  233. package/dist/docs/development/guides/resources/schemas/04-explore-schemas/_category_.json +11 -0
  234. package/dist/docs/development/guides/{schemas/03-schema-api.md → resources/schemas/05-schema-api.md} +6 -11
  235. package/dist/docs/development/guides/{schemas/04-schema-mcp.md → resources/schemas/06-schema-mcp.md} +5 -6
  236. package/dist/docs/development/guides/resources/schemas/07-reference.md +23 -0
  237. package/dist/docs/development/guides/{schemas → resources/schemas}/_category_.json +3 -3
  238. package/dist/docs/development/guides/resources/services/01-introduction.md +27 -0
  239. package/dist/docs/development/guides/resources/services/02-create-service.md +195 -0
  240. package/dist/docs/development/guides/resources/services/03-create-external-service.md +52 -0
  241. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/01-add-messages-to-services.md +142 -0
  242. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/02-add-data-stores-to-services.md +45 -0
  243. 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
  244. package/dist/docs/development/guides/resources/services/04-add-resources-to-services/_category_.json +11 -0
  245. 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
  246. package/dist/docs/development/guides/{services/ownership-and-components/02-components.md → resources/services/06-ownership-and-components/02-use-components.md} +4 -4
  247. package/dist/docs/development/guides/resources/services/06-ownership-and-components/_category_.json +11 -0
  248. package/dist/docs/development/guides/{services/versioning-and-lifecycle/01-versioning.md → resources/services/07-versioning-and-lifecycle/01-version-services.md} +4 -3
  249. package/dist/docs/development/guides/{services/versioning-and-lifecycle/02-changelog.md → resources/services/07-versioning-and-lifecycle/02-add-changelog.md} +5 -5
  250. package/dist/docs/development/guides/{services/versioning-and-lifecycle/03-deprecating.md → resources/services/07-versioning-and-lifecycle/03-deprecate-services.md} +5 -4
  251. package/dist/docs/development/guides/resources/services/07-versioning-and-lifecycle/_category_.json +11 -0
  252. package/dist/docs/development/guides/resources/services/08-reference.md +295 -0
  253. package/dist/docs/development/guides/{services → resources/services}/_category_.json +3 -3
  254. package/dist/docs/development/guides/systems/01-introduction.md +119 -0
  255. package/dist/docs/development/guides/systems/02-create-system.md +127 -0
  256. package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +157 -0
  257. package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +86 -0
  258. package/dist/docs/development/guides/systems/05-system-context-maps.md +67 -0
  259. package/dist/docs/development/guides/systems/06-reference.md +329 -0
  260. package/dist/docs/development/guides/{messages/queries → systems}/_category_.json +5 -5
  261. package/dist/docs/development/license-keys/_category_.json +1 -1
  262. package/dist/docs/development/license-keys/integrations.md +20 -9
  263. package/dist/docs/development/license-keys/overview.md +7 -18
  264. package/dist/docs/development/license-keys/plans.md +9 -18
  265. package/dist/docs/development/upgrading/v2.md +1 -2
  266. package/dist/docs/development/upgrading/v3.md +2 -3
  267. package/dist/docs/development/upgrading/v4.md +377 -0
  268. package/dist/docs/editor/00-overview.md +3 -3
  269. package/dist/docs/editor/01-first-edit.md +1 -1
  270. package/dist/docs/editor/explanation/markdown-mdx-git.md +1 -1
  271. package/dist/docs/editor/how-to/add-schemas-and-specifications.md +5 -5
  272. package/dist/docs/editor/how-to/edit-resource.md +1 -1
  273. package/dist/docs/editor/how-to/use-flow-editor.md +5 -5
  274. package/dist/docs/editor/how-to/use-slash-commands.md +2 -2
  275. package/dist/docs/editor/reference/supported-content.md +2 -2
  276. package/dist/docs/editor/reference/supported-resources.md +14 -14
  277. package/dist/docs/plugins/amazon-apigateway/00-intro.md +8 -8
  278. package/dist/docs/plugins/amazon-apigateway/01-installation.md +10 -12
  279. package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +5 -4
  280. package/dist/docs/plugins/apicurio/00-intro.md +8 -8
  281. package/dist/docs/plugins/apicurio/01-installation.md +12 -2
  282. package/dist/docs/plugins/apicurio/02-plugin-configuration.md +7 -9
  283. package/dist/docs/plugins/apicurio/03-features.md +2 -2
  284. package/dist/docs/plugins/asyncapi/00-intro.md +8 -8
  285. package/dist/docs/plugins/asyncapi/01-installation.md +10 -11
  286. package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +5 -5
  287. package/dist/docs/plugins/asyncapi/03-features.md +9 -9
  288. package/dist/docs/plugins/aws-glue-registry/00-intro.md +8 -8
  289. package/dist/docs/plugins/aws-glue-registry/00a-installation.md +16 -6
  290. package/dist/docs/plugins/aws-glue-registry/01-features.md +2 -2
  291. package/dist/docs/plugins/azure-schema-registry/00-intro.md +10 -10
  292. package/dist/docs/plugins/azure-schema-registry/01-installation.md +15 -5
  293. package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +4 -4
  294. package/dist/docs/plugins/azure-schema-registry/04-examples.md +1 -1
  295. package/dist/docs/plugins/backstage/00-intro.md +3 -3
  296. package/dist/docs/plugins/backstage/01-installation.md +7 -15
  297. package/dist/docs/plugins/confluent-schema-registry/00-intro.md +8 -8
  298. package/dist/docs/plugins/confluent-schema-registry/01-installation.md +12 -4
  299. package/dist/docs/plugins/confluent-schema-registry/02-plugin-configuration.md +3 -3
  300. package/dist/docs/plugins/eventbridge/00a-installation.md +21 -21
  301. package/dist/docs/plugins/eventbridge/01-features.md +3 -3
  302. package/dist/docs/plugins/eventbridge/03-api.md +5 -5
  303. package/dist/docs/plugins/eventcatalog-federation/00-introduction.md +6 -6
  304. package/dist/docs/plugins/eventcatalog-federation/01-installation.md +10 -11
  305. package/dist/docs/plugins/eventcatalog-federation/04-configuration.md +2 -2
  306. package/dist/docs/plugins/eventcatalog-federation/05-setup-team-catalog.md +5 -6
  307. package/dist/docs/plugins/github/00-intro.md +8 -8
  308. package/dist/docs/plugins/github/01-installation.md +12 -5
  309. package/dist/docs/plugins/graphql/00-intro.md +8 -8
  310. package/dist/docs/plugins/graphql/01-installation.md +11 -11
  311. package/dist/docs/plugins/graphql/02-plugin-configuration.md +3 -4
  312. package/dist/docs/plugins/graphql/03-features.md +4 -4
  313. package/dist/docs/plugins/openapi/00-intro.md +8 -8
  314. package/dist/docs/plugins/openapi/01-installation.md +10 -11
  315. package/dist/docs/plugins/openapi/02-plugin-configuration.md +7 -6
  316. package/dist/docs/plugins/openapi/03-features.md +6 -7
  317. package/dist/docs/tutorial/01-start-here.md +75 -0
  318. package/dist/docs/tutorial/02-install-eventcatalog.md +98 -0
  319. package/dist/docs/tutorial/04-add-ownership.md +184 -0
  320. package/dist/docs/tutorial/04-create-event.md +176 -0
  321. package/dist/docs/tutorial/05-create-a-domain.md +133 -0
  322. package/dist/docs/tutorial/05-publish-event.md +82 -0
  323. package/dist/docs/tutorial/06-consume-event.md +130 -0
  324. package/dist/docs/tutorial/06-create-a-service.md +99 -0
  325. package/dist/docs/tutorial/11-visualize-your-catalog.md +105 -0
  326. package/dist/docs/tutorial/12-build-your-catalog.md +79 -0
  327. package/dist/docs/tutorial/14-next-steps.md +108 -0
  328. package/dist/docs/tutorial/_category_.json +12 -0
  329. package/dist/eventcatalog.cjs +12 -4
  330. package/dist/eventcatalog.js +10 -10
  331. package/dist/generate.cjs +1 -1
  332. package/dist/generate.js +3 -3
  333. package/dist/utils/cli-logger.cjs +1 -1
  334. package/dist/utils/cli-logger.js +2 -2
  335. package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +4 -1
  336. package/eventcatalog/src/toolkit/layouts/Layout.astro +7 -1
  337. package/package.json +1 -1
  338. package/dist/docs/api/03-domain-api.md +0 -440
  339. package/dist/docs/api/04-service-api.md +0 -414
  340. package/dist/docs/api/05-command-api.md +0 -365
  341. package/dist/docs/api/06-event-api.md +0 -364
  342. package/dist/docs/api/06-query-api.md +0 -362
  343. package/dist/docs/api/08-channel-api.md +0 -363
  344. package/dist/docs/api/09-flow-api.md +0 -446
  345. package/dist/docs/api/10-entity-api.md +0 -330
  346. package/dist/docs/api/11-data-api.md +0 -273
  347. package/dist/docs/api/12-data-product-api.md +0 -445
  348. package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md +0 -68
  349. package/dist/docs/development/components/external-diagram-embeds/_category_.json +0 -12
  350. package/dist/docs/development/customization/custom-components/00-what-is-mdx.md +0 -73
  351. package/dist/docs/development/customization/custom-components/01-introduction.md +0 -28
  352. package/dist/docs/development/customization/custom-components/02-adding-components.md +0 -145
  353. package/dist/docs/development/customization/custom-components/03-component-styling.md +0 -27
  354. package/dist/docs/development/customization/custom-components/04-javascript-components.md +0 -32
  355. package/dist/docs/development/customization/custom-components/_category_.json +0 -11
  356. package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md +0 -85
  357. package/dist/docs/development/customization/customize-sidebars/_category_.json +0 -11
  358. package/dist/docs/development/developer-tools/github-action.md +0 -147
  359. package/dist/docs/development/guides/12-customize-your-sidebar.md +0 -12
  360. package/dist/docs/development/guides/agents/02-adding-agents.md +0 -152
  361. package/dist/docs/development/guides/agents/adding-to-agents/_category_.json +0 -10
  362. package/dist/docs/development/guides/agents/ownership/01-owners.md +0 -67
  363. package/dist/docs/development/guides/agents/ownership/_category_.json +0 -11
  364. package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md +0 -48
  365. package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md +0 -40
  366. package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md +0 -41
  367. package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json +0 -11
  368. package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md +0 -44
  369. package/dist/docs/development/guides/channels/ownership-and-components/02-components.md +0 -16
  370. package/dist/docs/development/guides/channels/ownership-and-components/_category_.json +0 -11
  371. package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md +0 -31
  372. package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md +0 -56
  373. package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json +0 -11
  374. package/dist/docs/development/guides/data/01-introduction.md +0 -34
  375. package/dist/docs/development/guides/data/02-adding-data.md +0 -86
  376. package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md +0 -73
  377. package/dist/docs/development/guides/data/ownership-and-components/01-owners.md +0 -45
  378. package/dist/docs/development/guides/data/ownership-and-components/02-components.md +0 -17
  379. package/dist/docs/development/guides/data/ownership-and-components/_category_.json +0 -11
  380. package/dist/docs/development/guides/data/versioning-and-lifecycle/01-versioning.md +0 -32
  381. package/dist/docs/development/guides/data/versioning-and-lifecycle/02-changelog.md +0 -57
  382. package/dist/docs/development/guides/data/versioning-and-lifecycle/03-deprecating.md +0 -71
  383. package/dist/docs/development/guides/data/versioning-and-lifecycle/_category_.json +0 -11
  384. package/dist/docs/development/guides/data-products/02-adding-data-products.md +0 -157
  385. package/dist/docs/development/guides/data-products/05-versioning.md +0 -240
  386. package/dist/docs/development/guides/data-products/06-adding-to-domains.md +0 -52
  387. package/dist/docs/development/guides/diagrams/01-introduction.md +0 -78
  388. package/dist/docs/development/guides/diagrams/02-creating-diagrams.md +0 -195
  389. package/dist/docs/development/guides/diagrams/04-versioning-diagrams.md +0 -204
  390. package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +0 -145
  391. package/dist/docs/development/guides/diagrams/06-diagrams-with-llms.md +0 -165
  392. package/dist/docs/development/guides/domains/02-creating-domains/_category_.json +0 -11
  393. package/dist/docs/development/guides/domains/04-versioning-and-changelogs/_category_.json +0 -10
  394. package/dist/docs/development/guides/domains/05-entities/01-introduction.md +0 -24
  395. package/dist/docs/development/guides/domains/05-entities/02-adding-entities.md +0 -157
  396. package/dist/docs/development/guides/domains/05-entities/03-adding-entities-to-domains.md +0 -30
  397. package/dist/docs/development/guides/domains/05-entities/04-domain-entity-map.md +0 -134
  398. package/dist/docs/development/guides/flows/01-introduction.md +0 -36
  399. package/dist/docs/development/guides/flows/02-adding-flows.md +0 -198
  400. package/dist/docs/development/guides/flows/04-adding-flows-to-services.md +0 -42
  401. package/dist/docs/development/guides/flows/05-adding-flows-to-domains.md +0 -43
  402. package/dist/docs/development/guides/flows/06-versioning.md +0 -27
  403. package/dist/docs/development/guides/flows/07-create-flow-with-ai.md +0 -171
  404. package/dist/docs/development/guides/messages/01-overview.md +0 -57
  405. package/dist/docs/development/guides/messages/_category_.json +0 -11
  406. package/dist/docs/development/guides/messages/commands/02-adding-commands.md +0 -131
  407. package/dist/docs/development/guides/messages/commands/_category_.json +0 -11
  408. package/dist/docs/development/guides/messages/common/01-map-to-producers-and-consumers.md +0 -37
  409. package/dist/docs/development/guides/messages/common/02-adding-schemas.md +0 -58
  410. package/dist/docs/development/guides/messages/common/03-owners.md +0 -40
  411. package/dist/docs/development/guides/messages/common/07-components.md +0 -12
  412. package/dist/docs/development/guides/messages/common/08-shared-messages-across-boundaries.md +0 -70
  413. package/dist/docs/development/guides/messages/common/_category_.json +0 -11
  414. package/dist/docs/development/guides/messages/events/02-adding-events.md +0 -130
  415. package/dist/docs/development/guides/messages/events/_category_.json +0 -11
  416. package/dist/docs/development/guides/messages/queries/01-introduction.md +0 -25
  417. package/dist/docs/development/guides/messages/queries/02-adding-queries.md +0 -130
  418. package/dist/docs/development/guides/owners/teams/01-introduction.md +0 -21
  419. package/dist/docs/development/guides/owners/teams/02-adding-teams.md +0 -73
  420. package/dist/docs/development/guides/owners/teams/_category_.json +0 -11
  421. package/dist/docs/development/guides/owners/users/01-introduction.md +0 -20
  422. package/dist/docs/development/guides/owners/users/02-adding-users.md +0 -69
  423. package/dist/docs/development/guides/owners/users/_category_.json +0 -11
  424. package/dist/docs/development/guides/schemas/01-introduction.md +0 -64
  425. package/dist/docs/development/guides/services/01-introduction.md +0 -33
  426. package/dist/docs/development/guides/services/02-adding-services.md +0 -113
  427. package/dist/docs/development/guides/services/03-creating-external-systems.md +0 -71
  428. package/dist/docs/development/guides/services/adding-to-services/01-messages.md +0 -229
  429. package/dist/docs/development/guides/services/adding-to-services/02-datastores.md +0 -77
  430. package/dist/docs/development/guides/services/adding-to-services/_category_.json +0 -10
  431. package/dist/docs/development/guides/services/ownership-and-components/_category_.json +0 -11
  432. package/dist/docs/development/guides/services/versioning-and-lifecycle/_category_.json +0 -11
  433. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/01-introduction.md +0 -0
  434. /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/02-installation.md +0 -0
  435. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/01-introduction.md +0 -0
  436. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/02-slack-app-setup.md +0 -0
  437. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/04-deployment.md +0 -0
  438. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/05-usage.md +0 -0
  439. /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/06-troubleshooting.md +0 -0
  440. /package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/09-configuration +0 -0
@@ -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
- ```
@@ -66,6 +66,7 @@ Success! You are now ready to start building with EventCatalog! 🥳
66
66
 
67
67
  Here are a few things that we recommend exploring next. You can read them in any order. You can even leave our documentation for a bit and go play in your new EventCatalog project codebase, coming back here whenever you run into trouble or have a question.
68
68
 
69
- - [Create your first domain](/docs/development/guides/domains/creating-domains/adding-domains)
70
- - [Create your first service](/docs/development/guides/services/adding-services)
71
- - [Create your first message](/docs/messages)
69
+ - [Create your first domain](/docs/development/guides/domains/create-domain)
70
+ - [Create your first system](/docs/development/guides/systems/create-system)
71
+ - [Create your first service](/docs/development/guides/resources/services/create-service)
72
+ - [Create your first message](/docs/development/guides/resources/messages/what-are-messages)
@@ -106,6 +106,6 @@ To use the editor, you need Git installed and editor access through [EventCatalo
106
106
 
107
107
  - [Understand the project structure](/docs/development/getting-started/project-structure)
108
108
  - [Develop and build your catalog](/docs/development/getting-started/develop-and-build)
109
- - [Create your first domain](/docs/development/guides/domains/creating-domains/adding-domains)
110
- - [Create your first service](/docs/development/guides/services/adding-services)
111
- - [Document your first message](/docs/development/guides/messages/overview)
109
+ - [Create your first domain](/docs/development/guides/domains/create-domain)
110
+ - [Create your first service](/docs/development/guides/resources/services/create-service)
111
+ - [Document your first message](/docs/development/guides/resources/messages/what-are-messages)
@@ -13,22 +13,25 @@ An EventCatalog project is a folder of Markdown files that describe and model yo
13
13
 
14
14
  You can edit these files directly, or use the optional [EventCatalog Editor](/docs/editor/overview) to create, preview, review, and commit catalog content through a visual workflow.
15
15
 
16
- Each resource in your catalog, such as a domain, service, event, command, query, team, or diagram, is represented by a file or folder in your project. EventCatalog reads those files and turns them into a catalog.
16
+ Each resource type in your catalog (e.g domain, system, message) is represented by a file or folder in your project. EventCatalog reads those files and turns them into a catalog.
17
17
 
18
- You can also bring your own documentation into EventCatalog, such as architecture decision records, guides, onboarding material, or runbooks. Learn more about [bringing your own documentation](/docs/development/bring-your-own-documentation/introduction).
18
+ You can also bring your own documentation into EventCatalog, such as guides, onboarding material, or runbooks. Learn more about [bringing your own documentation](/docs/development/bring-your-own-documentation/introduction).
19
19
 
20
20
  All resource types are optional. You decide what you want to document, and you can add more resource types later as your catalog becomes more useful to your teams.
21
21
 
22
22
  ## Directories and files
23
23
 
24
- Every EventCatalog project has a few core files used to run and configure the catalog. The resource folders, such as `domains/`, `services/`, `channels/`, and `diagrams/`, are optional and depend on what you want to document.
24
+ Every EventCatalog project has a few core files used to run and configure the catalog.
25
25
 
26
- EventCatalog creates resources from folders that contain an `index.mdx` file. For example, `domains/Orders/index.mdx` creates an `Orders` domain, and `domains/Orders/services/OrderService/index.mdx` creates an `OrderService` service inside that domain.
26
+ Architecture resources exist in folders such as `domains/`, `systems/`, `services/`, and `events/`. All resources in EventCatalog are optional, it's up to you how you want to model and document your architecture.
27
+
28
+ EventCatalog creates resources from folders that contain an `index.mdx` file. For example, `domains/Orders/index.mdx` creates an `Orders` domain, `domains/Orders/systems/order-management-system/index.mdx` creates an `order-management-system` system inside that domain, and `domains/Orders/systems/order-management-system/services/OrderService/index.mdx` creates an `OrderService` service inside that system.
27
29
 
28
30
  - `eventcatalog.config.js` - Configures your catalog.
29
31
  - `package.json` - Defines scripts and dependencies.
30
32
  - `public/` - Stores static assets that should be served directly.
31
33
  - `domains/` - Documents business domains and bounded contexts.
34
+ - `systems/` - Documents groups of resources that work together to provide a capability.
32
35
  - `services/` - Documents services, APIs, applications, external systems, jobs, and workers.
33
36
  - `events/`, `commands/`, `queries/` - Documents messages.
34
37
  - `channels/` - Documents topics, queues, streams, webhooks, or other communication paths.
@@ -46,62 +49,101 @@ A common EventCatalog project directory might look like this:
46
49
  {
47
50
  name: 'domains',
48
51
  type: 'folder',
49
- defaultOpen: true,
52
+ defaultOpen: false,
50
53
  children: [
51
54
  {
52
55
  name: 'Orders',
53
56
  type: 'folder',
54
- defaultOpen: true,
57
+ defaultOpen: false,
55
58
  children: [
56
59
  { name: 'index.mdx', highlight: true },
57
60
  {
58
- name: 'services',
61
+ name: 'systems',
59
62
  type: 'folder',
60
- defaultOpen: true,
63
+ defaultOpen: false,
61
64
  children: [
62
65
  {
63
- name: 'OrderService',
66
+ name: 'order-management-system',
64
67
  type: 'folder',
65
- defaultOpen: true,
68
+ defaultOpen: false,
66
69
  children: [
67
- { name: 'index.mdx' },
68
- { name: 'openapi.yaml' },
69
- { name: 'asyncapi.yaml' },
70
+ { name: 'index.mdx', highlight: true },
70
71
  {
71
- name: 'events',
72
+ name: 'services',
72
73
  type: 'folder',
73
- defaultOpen: true,
74
+ defaultOpen: false,
74
75
  children: [
75
76
  {
76
- name: 'OrderPlaced',
77
+ name: 'OrderService',
77
78
  type: 'folder',
78
- defaultOpen: true,
79
+ defaultOpen: false,
79
80
  children: [
80
81
  { name: 'index.mdx' },
81
- { name: 'schema.avsc' },
82
+ { name: 'openapi.yaml' },
83
+ { name: 'asyncapi.yaml' },
84
+ {
85
+ name: 'events',
86
+ type: 'folder',
87
+ defaultOpen: false,
88
+ children: [
89
+ {
90
+ name: 'OrderPlaced',
91
+ type: 'folder',
92
+ defaultOpen: false,
93
+ children: [
94
+ { name: 'index.mdx' },
95
+ { name: 'schema.avsc' },
96
+ ],
97
+ },
98
+ ],
99
+ },
100
+ {
101
+ name: 'commands',
102
+ type: 'folder',
103
+ defaultOpen: false,
104
+ children: [
105
+ {
106
+ name: 'CancelOrder',
107
+ type: 'folder',
108
+ children: [{ name: 'index.mdx' }],
109
+ },
110
+ ],
111
+ },
112
+ {
113
+ name: 'queries',
114
+ type: 'folder',
115
+ defaultOpen: false,
116
+ children: [
117
+ {
118
+ name: 'GetOrder',
119
+ type: 'folder',
120
+ children: [{ name: 'index.mdx' }],
121
+ },
122
+ ],
123
+ },
82
124
  ],
83
125
  },
84
126
  ],
85
127
  },
86
128
  {
87
- name: 'commands',
129
+ name: 'containers',
88
130
  type: 'folder',
89
131
  defaultOpen: false,
90
132
  children: [
91
133
  {
92
- name: 'CancelOrder',
134
+ name: 'orders-db',
93
135
  type: 'folder',
94
136
  children: [{ name: 'index.mdx' }],
95
137
  },
96
138
  ],
97
139
  },
98
140
  {
99
- name: 'queries',
141
+ name: 'flows',
100
142
  type: 'folder',
101
143
  defaultOpen: false,
102
144
  children: [
103
145
  {
104
- name: 'GetOrder',
146
+ name: 'order-fulfilment',
105
147
  type: 'folder',
106
148
  children: [{ name: 'index.mdx' }],
107
149
  },
@@ -115,30 +157,6 @@ A common EventCatalog project directory might look like this:
115
157
  },
116
158
  ],
117
159
  },
118
- {
119
- name: 'channels',
120
- type: 'folder',
121
- defaultOpen: false,
122
- children: [
123
- {
124
- name: 'orders.events',
125
- type: 'folder',
126
- children: [{ name: 'index.mdx' }],
127
- },
128
- ],
129
- },
130
- {
131
- name: 'diagrams',
132
- type: 'folder',
133
- defaultOpen: false,
134
- children: [
135
- {
136
- name: 'system-context',
137
- type: 'folder',
138
- children: [{ name: 'index.mdx' }],
139
- },
140
- ],
141
- },
142
160
  {
143
161
  name: 'teams',
144
162
  type: 'folder',
@@ -168,104 +186,19 @@ A common EventCatalog project directory might look like this:
168
186
 
169
187
  You do not need every folder on day one. Start with the resources you know about, then add more as your catalog grows.
170
188
 
171
- ### `domains/`
172
-
173
- The `domains/` folder documents the business areas or bounded contexts in your architecture, such as `Orders`, `Payments`, or `Shipping`.
174
-
175
- Domains can contain their own documentation, services, messages, diagrams, and other resources. This is the most common way to structure larger catalogs because related architecture stays close together.
176
-
177
- Learn more in the [domains guide](/docs/development/guides/domains/introduction).
178
-
179
- ### `services/`
180
-
181
- The `services/` folder documents services, APIs, applications, external systems, jobs, and workers.
182
-
183
- Services can live inside a domain, such as `domains/Orders/services/OrderService/`, or at the root of your catalog, such as `services/OrderService/`.
184
-
185
- Services often contain OpenAPI, AsyncAPI, or GraphQL specifications and the messages they own.
186
-
187
- Learn more in the [services guide](/docs/development/guides/services/introduction).
188
-
189
- ### `events/`, `commands/`, and `queries/`
190
-
191
- The `events/`, `commands/`, and `queries/` folders document messages exchanged between services.
192
-
193
- These folders can live inside a service when that service owns the message, or elsewhere in your catalog if you prefer a flatter structure.
194
-
195
- Message folders can also contain schemas, examples, and version history.
196
-
197
- Learn more in the [messages guide](/docs/development/guides/messages/overview).
198
-
199
- ### `channels/`
200
-
201
- The `channels/` folder documents where messages flow, such as Kafka topics, queues, streams, webhooks, or other integration points.
202
-
203
- Use channels when you want to explain the transport layer of your architecture, not just the messages themselves.
204
-
205
- Learn more in the [channels guide](/docs/development/guides/channels/introduction).
206
-
207
- ### `diagrams/`
208
-
209
- The `diagrams/` folder documents architecture diagrams, flows, and visual explanations.
210
-
211
- Diagrams can live at the root of your catalog or inside another resource, such as a domain or service.
212
-
213
- Learn more in the [diagrams guide](/docs/development/guides/diagrams/introduction).
214
-
215
- ### `teams/` and `users/`
216
-
217
- The `teams/` and `users/` folders document ownership metadata.
218
-
219
- Teams and users are usually represented as files directly inside their folder:
220
-
221
- ```bash
222
- teams/
223
- └── mobile-team.mdx
224
-
225
- users/
226
- └── dboyne.mdx
227
- ```
228
-
229
- Use these when you want ownership to be visible across domains, services, messages, schemas, and other resources.
230
-
231
- Learn more in the [teams guide](/docs/development/guides/owners/teams/introduction) and [users guide](/docs/development/guides/owners/users/introduction).
232
-
233
- ### `public/`
234
-
235
- The `public/` folder stores static assets that should be served directly, such as icons, images, and files.
236
-
237
- For example, if a service icon lives at `public/icons/orders.svg`, you can reference it from your resource metadata using `/icons/orders.svg`.
238
-
239
- ### `eventcatalog.config.js`
240
-
241
- The `eventcatalog.config.js` file configures your catalog, including title, output mode, integrations, and feature settings.
242
-
243
- See the [configuration API](/docs/api/config).
244
-
245
- ### `package.json`
246
-
247
- The `package.json` file defines the scripts and dependencies used to run, build, and preview your catalog.
248
-
249
- Most EventCatalog projects include scripts such as `npm run dev` and `npm run build`.
250
-
251
189
  ## What should I create first?
252
190
 
253
- If you are starting from an empty catalog, create resources in this order:
191
+ If you want to create your first few resources you can follow our [Learning EventCatalog Guide](/learn).
254
192
 
255
- 1. Add a domain for a business area, such as `Orders`.
256
- 2. Add one service inside that domain.
257
- 3. Add one event, command, or query owned by that service.
258
- 4. Add a team that owns the service.
259
- 5. Add channels or diagrams once you want to explain how things connect.
193
+ ## Next Steps
260
194
 
261
- That gives you a useful catalog quickly without needing to model everything up front.
195
+ Now you know some of the ways EventCatalog work, you can start to document some of your architecture resources.
196
+ Here are some links below to help depending on what you want to document.
262
197
 
263
- ## Learn more
198
+ :::tip Using AI to help
199
+ AI is great at helping you document and get going with EventCatalog. You can install our [EventCatalog Skills](https://github.com/event-catalog/eventcatalog-skills) to teach your LLM about EventCatalog, and then ask your LLM to help you get going.
200
+ :::
264
201
 
265
- - [Domains](/docs/development/guides/domains/introduction)
266
- - [Services](/docs/development/guides/services/introduction)
267
- - [Messages](/docs/development/guides/messages/overview)
268
- - [Channels](/docs/development/guides/channels/introduction)
269
- - [Diagrams](/docs/development/guides/diagrams/introduction)
270
- - [Teams](/docs/development/guides/owners/teams/introduction)
271
- - [Users](/docs/development/guides/owners/users/introduction)
202
+ - [Start documenting a business domain](/docs/development/guides/domains/introduction)
203
+ - [Start documenting a system](/docs/development/guides/systems/create-system)
204
+ - [Start documenting producers and consumers of a service](/docs/development/guides/resources/services/introduction)
@@ -1,5 +1,5 @@
1
1
  ---
2
- sidebar_position: 2
2
+ sidebar_position: 1
3
3
  keywords:
4
4
  - components
5
5
  sidebar_label: Using AI with EventCatalog
@@ -9,81 +9,13 @@ description: Architecture documentation for humans and AI
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
11
 
12
- EventCatalog helps you document your architecture for both teams and your AI tools. Your team gets a visual catalog to explore your system. Your AI tools get structured access to query and reason about your architecture.
13
-
14
- You can disable the AI chat feature at any time by setting `chat.enabled: false` in your `eventcatalog.config.js`. This hides the chat UI and stops chat requests even when all other prerequisites (plan, server mode, config file) are met.
15
-
16
- ## AI integrations
12
+ EventCatalog creates an internal graph of your architecture. Perfect for AI and LLMs.
17
13
 
18
14
  EventCatalog supports five ways to use AI with your catalog:
19
15
 
20
- - [EventCatalog Assistant](/docs/development/ask-your-architecture/eventcatalog-assistant/what-is-eventcatalog-assistant)
21
- - Bring your own model to EventCatalog itself, and ask questions about your documentation directly in the browser.
22
- - [EventCatalog MCP Server](/docs/development/ask-your-architecture/mcp-server/introduction)
23
- - Connect your MCP clients (e.g Cursor, Windsurf, Claude Desktop) to EventCatalog.
24
- - [Slack Integration](/docs/development/ask-your-architecture/slack-integration/introduction)
25
- - Query your architecture directly from Slack using the EventCatalog Slack Bot.
26
- - [AI Skills](/docs/development/ask-your-architecture/skills/introduction)
27
- - Pre-built skills that teach AI coding agents how to generate correct EventCatalog documentation.
28
- - [Bundled docs for coding agents](#bundled-docs-for-coding-agents)
29
- - Version-matched docs bundled inside `@eventcatalog/core` so agents always reference accurate APIs, not stale training data.
30
-
31
- ## Bundled docs for coding agents
32
-
33
- <AddedIn version="3.35.1" />
34
-
35
- AI coding agents (Claude Code, Cursor, Copilot, and others) are trained on a snapshot of the web. EventCatalog's API, frontmatter conventions, and folder structure evolve with each release, so an agent relying on training data alone may generate outdated or incorrect files.
36
-
37
- Starting in `3.35.1`, `@eventcatalog/core` bundles the full documentation inside the package itself. After installing EventCatalog, the docs are available at:
38
-
39
- ```
40
- node_modules/@eventcatalog/core/dist/docs/
41
- ```
42
-
43
- No extra install or network request is needed. The bundled docs mirror the structure of the EventCatalog website (api, cli, development, plugins, and more) and are always version-matched to the package you have installed.
44
-
45
- ### Use with new projects
46
-
47
- Projects scaffolded with `npx create-eventcatalog@latest` automatically receive two files in the project root:
48
-
49
- - `AGENTS.md` — read by most coding agents before they act. It tells the agent to find and read the relevant doc in `node_modules/@eventcatalog/core/dist/docs/` before doing any EventCatalog work.
50
- - `CLAUDE.md` — a single `@AGENTS.md` line that re-exports the rules for Claude Code without duplicating content.
51
-
52
- No manual setup is required for new projects.
53
-
54
- ### Use with existing projects
55
-
56
- Add the two files to the root of your EventCatalog project:
57
-
58
- **`AGENTS.md`**
59
-
60
- ```markdown
61
- <!-- BEGIN:eventcatalog-agent-rules -->
62
- # EventCatalog: ALWAYS read docs before coding
63
-
64
- Before any EventCatalog work, find and read the relevant doc in `node_modules/@eventcatalog/core/dist/docs/`. Your training data may be outdated. The bundled docs are the source of truth.
65
-
66
- <!-- END:eventcatalog-agent-rules -->
67
- ```
68
-
69
- **`CLAUDE.md`**
70
-
71
- ```
72
- @AGENTS.md
73
- ```
74
-
75
- The `BEGIN` / `END` markers in `AGENTS.md` let you add your own project-specific instructions outside the managed block. EventCatalog will only update content inside those markers in future releases.
76
-
77
- ### Understand the docs layout
78
-
79
- The bundled docs follow the same structure as the EventCatalog website:
80
-
81
- ```
82
- node_modules/@eventcatalog/core/dist/docs/
83
- ├── api/ # Frontmatter reference for all resource types
84
- ├── cli/ # CLI commands
85
- ├── development/ # Getting started, guides, customization
86
- └── plugins/ # Generator and plugin documentation
87
- ```
88
-
89
- Point your agent at a specific subdirectory when you want it to focus. For example, to document a new service, read `dist/docs/api/04-service-api.md` and `dist/docs/development/guides/services/`.
16
+ - [llms.txt](/docs/development/ask-your-architecture/llms.txt) - Give AI tools a machine-readable index of your catalog.
17
+ - [schemas.txt](/docs/development/ask-your-architecture/schemas.txt) - Give AI tools access to your schemas and specifications.
18
+ - [EventCatalog Assistant](/docs/development/ask-your-architecture/eventcatalog-assistant/what-is-eventcatalog-assistant) - AI Chat in your Catalog.
19
+ - [EventCatalog MCP Server](/docs/development/ask-your-architecture/mcp-server/introduction) - Connect EventCatalog to Agents through MCP
20
+ - [EventCatalog Agent](/docs/development/ask-your-architecture/agents/overview) - CI/CD Agent for breaking changes and doc updates
21
+ - [AI Skills](/docs/development/ask-your-architecture/skills/introduction) - Install our Skills to help you manage your catalog
@@ -8,15 +8,16 @@ description: Learn how EventCatalog Assistant helps users explore documentation
8
8
  ---
9
9
 
10
10
  import AddedIn from '@site/src/components/MDX/AddedIn';
11
- import EventCatalogPro from '@site/src/components/MDX/EventCatalogPro';
12
11
 
13
12
  import PlanBanner from '@site/src/components/MDX/PlanBanner';
14
13
 
15
14
  <PlanBanner plan="Scale" />
16
15
 
17
- EventCatalog Assistant allows users to ask questions about your documentation using natural language. It is embedded directly into your documentation site, enabling users to quickly find answers, understand your system, and succeed without manually searching through pages.
16
+ EventCatalog Assistant brings AI chat to your catalog.
18
17
 
19
- **You can bring your own model to EventCatalog and your data is owned by you and never shared.**
18
+ It is embedded directly into your documentation site, enabling users to quickly find answers, understand your system, and succeed without manually searching through pages.
19
+
20
+ **You bring your own model to EventCatalog and your data is owned by you and never shared.**
20
21
 
21
22
  The assistant integrates with your preferred AI models using the [AI SDK](https://ai-sdk.dev/), giving you full control over which models power the experience.
22
23
 
@@ -7,6 +7,7 @@ title: Configuration
7
7
  description: Configure EventCatalog Assistant
8
8
  ---
9
9
 
10
+ import AddedIn from '@site/src/components/MDX/AddedIn';
10
11
  import PlanBanner from '@site/src/components/MDX/PlanBanner';
11
12
 
12
13
  <PlanBanner plan="Scale" />
@@ -69,4 +70,4 @@ export const configuration = {
69
70
  }
70
71
  ```
71
72
 
72
- Once you have enabled the feature and configured your model, restart EventCatalog and you can start asking questions about your architecture.
73
+ Once you have enabled the feature and configured your model, restart EventCatalog and you can start asking questions about your architecture.
@@ -6,7 +6,7 @@ keywords:
6
6
  - AI Tools
7
7
  - Runtime Data
8
8
  - Metrics
9
- sidebar_label: Custom Tools
9
+ sidebar_label: Configure your own tools
10
10
  title: Custom Tools
11
11
  description: Extend EventCatalog Assistant with custom tools to bring real-time data, metrics, and integrations into your architecture conversations
12
12
  ---
@@ -14,8 +14,6 @@ description: Extend EventCatalog Assistant with custom tools to bring real-time
14
14
  import PlanBanner from '@site/src/components/MDX/PlanBanner';
15
15
  import AddedIn from '@site/src/components/MDX/AddedIn';
16
16
 
17
- <AddedIn version="3.2.0" />
18
-
19
17
  <PlanBanner plan="Scale" />
20
18
 
21
19
  EventCatalog Assistant comes with built-in tools that allow the AI to search and understand your architecture documentation. But what if you could go beyond static documentation and bring **real-time data** directly into your conversations?
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "label": "EventCatalog Assistant",
3
- "position": 2,
3
+ "position": 4,
4
4
  "collapsible": true,
5
5
  "collapsed": true,
6
6
  "link": {
@@ -8,4 +8,4 @@
8
8
  "slug": "/development/guides/eventcatalog-assistant",
9
9
  "description": "EventCatalog Assistant"
10
10
  }
11
- }
11
+ }
@@ -1,5 +1,5 @@
1
1
  ---
2
- sidebar_position: 3
2
+ sidebar_position: 2
3
3
  keywords:
4
4
  - llms.txt
5
5
  - AI
@@ -63,4 +63,3 @@ Once you deploy your EventCatalog you can use your tools to ask questions about
63
63
 
64
64
 
65
65
 
66
-
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "label": "EventCatalog MCP Server",
3
- "position": 2,
3
+ "position": 5,
4
4
  "collapsible": true,
5
5
  "collapsed": true,
6
6
  "link": {
@@ -9,4 +9,4 @@
9
9
  "title": "MCP Server",
10
10
  "description": "This section contains tutorials for the EventCatalog MCP Server."
11
11
  }
12
- }
12
+ }
@@ -15,7 +15,7 @@ import PlanBanner from '@site/src/components/MDX/PlanBanner';
15
15
  ### Prerequisites
16
16
 
17
17
  1. **SSR mode** - EventCatalog must run in [server mode](/docs/development/deployment/build-ssr-mode#building-your-eventcatalog-ssr) (not static)
18
- 2. **Scale license** - You can get a 14 day free trial at [eventcatalog.cloud](https://eventcatalog.cloud)
18
+ 2. **Scale license** - You can get a 30-day free trial at [eventcatalog.cloud](https://eventcatalog.cloud)
19
19
 
20
20
  ### Quick start
21
21
 
@@ -240,7 +240,7 @@ For catalogs without SSR mode, use the standalone `@eventcatalog/mcp-server` pac
240
240
  For local development and testing, you can use the MCP Server on stdio. This is useful for single-client, low-latency tools.
241
241
 
242
242
  **Prerequisites:**
243
- - EventCatalog configured with the [`LLMS.txt` feature](/docs/development/developer-tools/llms.txt)
243
+ - EventCatalog configured with the [`LLMS.txt` feature](/docs/development/ask-your-architecture/llms.txt)
244
244
  - EventCatalog Scale license
245
245
  - MCP client installed
246
246