Event Catalog Editor

Event Catalog Editor

A GitHub-native workspace for building and maintaining EventCatalogs. Open repositories, edit MDX metadata, and keep your catalog consistent without local clones.

GitHub-first MDX-powered Catalog-aware
Event Catalog Editor Icon

Authentication & Profiles

  • GitHub OAuth login with repository and organization access.
  • Logout, access denied, and login error recovery flows.
  • User profile page with GitHub avatar/login plus editable display name and email.

Project & Repository Management

  • Open projects by selecting a GitHub repo and branch with search, filters, and visibility badges.
  • Live branch loading with EventCatalog structure validation and completeness warnings.
  • Create or initialize repositories with scaffolded EventCatalog folders and config.
  • Recent projects list with pin/unpin, last-opened timestamps, remove, and resume flows.
  • Close projects to clear context and start clean.

Navigation & Context

  • Project context persisted in the query string for shareable links.
  • Deep links to entities or custom docs using entity type and path.
  • Sidebar navigation with collapsible sections, active highlights, and manual refresh.
  • Catalog indexing from GitHub with support for domains, services, and messages at root or nested.
  • Custom docs discovery under /docs with nested folders.

Entity Browsing & Creation

  • Dedicated list pages for Domains, Services, Events, Commands, and Queries.
  • Context badges reveal domain and service relationships at a glance.
  • Create new entities with flexible placement options for services and messages.
  • Commit dialog includes message, HTML diff preview, and raw MDX preview.

Editing & Metadata

  • Common metadata fields for name, description, and owners.
  • Domain, Service, and Message metadata with tags, links, channels, producers, consumers, and references.
  • Markdown body editor with toggleable live preview and unsaved-changes indicator.
  • Preserves unknown frontmatter keys on save to protect custom metadata.

Message Catalog & Relationships

  • Builds a message catalog with version awareness from frontmatter.
  • Receives/sends selectors include versioned messages for accurate references.
  • Invalid references are flagged with quick removal actions.
  • Producers and consumers are selectable from discovered services.

Custom Docs

  • Edit existing MDX docs under /docs with title and summary metadata.
  • Markdown editor with preview plus commit dialog and raw MDX preview.
  • Conflict detection with reload flows when remote content changes.

GitHub Safety & Reliability

  • All content read/write happens through the GitHub API with direct commits to the selected branch.
  • SHA-based conflict detection prevents accidental overwrites.
  • Reload flow when remote content changes.
  • In-memory caching for project indexing and file content speed.
  • Stage multiple changes to entities and custom docs for efficient batch updates to GitHub.