Add breadcrumbs for user navigation #12

Athul0491 · 2023-12-27T13:36:30Z

Add breadcrumbs which allow users to navigate through their file tree

Athul0491 · 2024-03-09T18:17:58Z

After going through the description, prerequisites and the todo, I came up with a MVP.

This is an HTTP API that generates an Open Graph image based on:

To generate an Open Graph image using the URL pointing to raw AsyncAPI document:
Go to /api/og?docurl={link_of_your_doc}

To generate an Open Graph image using base64 encoded AsyncAPI document:
Go to /api/og?base64={base64_encoded_doc}

Example:

Dynamic OpenGraph image

To make the OpenGraph image show dynamically based on such parameters, I tried adding a script in the
<head> tag of public/index.html and by various other methods, but they were not concrete solutions.
react-helmet also does not seem to be a viable option as it does not provide support for web crawlers
and it does not provide good compatibility with opengraph data.
It is also considered to be deprecated as it is not currently being maintained.

Current issues:

For nextjs apps, there is a package called next-seo. We need something similar or need to find a workaround for this. Would need to investigate more for this.
The speed of preview picture generation on Studio would be slow unless caching is applied.
Design of the open graph image needs to be worked on.

_Any suggestions and insights are highly appreciated_ Cheers, Athul

Provide feedback