An open source documentation tool to bring discoverability to your event-driven architectures

architecture catalog ddd documentation eda event-driven events plugins
4 Open Issues Need Help Last updated: Dec 2, 2024

Open Issues Need Help

View All on GitHub

AI Summary: Fix the EventCatalog's pagefind search functionality to correctly incorporate the configured `base` path when locating the necessary JavaScript and CSS files. This involves modifying the code to prepend the `base` path to the pagefind resource URLs, resolving the 'search index not found' error.

Complexity: 3/5
bug help wanted good first issue

An open source documentation tool to bring discoverability to your event-driven architectures

TypeScript
#architecture#catalog#ddd#documentation#eda#event-driven#events#plugins

AI Summary: The task requires modifying the EventCatalog's MDX loader to enable the import and use of custom Astro components within user and team MDX files. Currently, this functionality is limited, preventing the inclusion of custom interactive elements like skill matrices or contribution timelines. The solution involves adjusting the MDX processing to correctly handle custom component imports, mirroring the behavior already present in other sections of the documentation.

Complexity: 3/5
good first issue ✨ enhancement ready-for-implementation

An open source documentation tool to bring discoverability to your event-driven architectures

TypeScript
#architecture#catalog#ddd#documentation#eda#event-driven#events#plugins

AI Summary: Implement a prop (e.g., `mode`) in the `NodeGraph` and `Flow` components of the EventCatalog documentation tool to allow users to choose between 'full' and 'simple' visualization modes, overriding the default behavior based on context (full screen vs. embedded). This enhances user control over the visual representation of event-driven architectures within the documentation.

Complexity: 3/5
good first issue needs-discussion ✨ enhancement

An open source documentation tool to bring discoverability to your event-driven architectures

TypeScript
#architecture#catalog#ddd#documentation#eda#event-driven#events#plugins

AI Summary: Debug and fix a rendering issue in the EventCatalog open-source documentation tool where mermaid diagrams embedded within accordions fail to render correctly, instead displaying a 'Loading graph...' message. The issue occurs specifically with version @eventcatalog/core@^2.34.7 on a Windows platform. The solution requires investigating the integration between the mermaid library, the accordion component, and the EventCatalog framework to identify and resolve the rendering conflict.

Complexity: 4/5
bug good first issue

An open source documentation tool to bring discoverability to your event-driven architectures

TypeScript
#architecture#catalog#ddd#documentation#eda#event-driven#events#plugins