Quick question: Is there way to embed flow readme in flow source code? https://docs.prefect.io/orchestration/ui/flow.html#read-me

Hey @Shaoyi Zhang, I don’t believe so. The readme from the UI is completely separate from your source

Maybe something like this https://github.com/PrefectHQ/prefect/issues/4154#issuecomment-930245627?

Thank you both! Allowing readme to be part of flow source code would be very helpful.

@Shaoyi Zhang thanks for the suggestion! I’ll make sure to pass it along

Hey @Shaoyi Zhang, we have heard this a lot, and this is why in Orion the flow description will be easily added, or it can be taken from your flow docstring as seen in the API docs here

This is great! Another reason to try Orion🚀

Hey Everyone, I don't suppose anyone could help me with a query related to this thread. I'm currently trying to add an image from my remote repo into the Flow's

README

. I successfully implemented the suggested flow Register method (above) but my images aren't showing. What's the best way to resolve this?

Are the images public and are you using markdown to render them?

Markdown

Do you see a link or nothing at all?

Pardon me, I forgot to mention that the images are not public and only the markdown's alt. text is being returned.

The images need to be public for it to render

Ah, I see. Thanks @Kevin Kho!