event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.69k stars 143 forks source link

index.md in the root event folder is not reflecting written content #686

Open jr-araujo opened 1 month ago

jr-araujo commented 1 month ago

🚨 Problem:

When trying to add content to describe an event using the index.md file under the root event folder, the written content is not rendered on the UI. The written content is only rendered when changing the versioned index.md, as depicted in the image below:

Changes in both files: image

Content is rendered only when changing the versioned index.md file: image

✅ Expectation:

EC should consider the content from the index.md under the root event folder when rendering the event as the main page. When the changelog page is opened, only from this point should the content in both files be considered to show the end user the changes this event eventually had.

carlosallexandre commented 1 month ago

@jr-araujo This happens because the page under versioned has the same version as the root page (in the frontmatter) overwriting the root when getting with the EC (currently). But, i think keeping two index.md pointing to the same version is not the best approach. They will diverge at some point. Either way, i agree with you that this sould be checked.

jr-araujo commented 1 month ago

This is the same behavior for the schemas.

carlosallexandre commented 1 month ago

I will work on a solution for this