What would be the cleanest way to write a brief de...
# ask-community
h
What would be the cleanest way to write a brief description about what a flow does in the UI?
k
Hi @Hwi Moon, there is a README tab in the flow page you can add details to
h
Yes, but is there a way a user can see the description like a sentence or two at the main page of a flow?
vs. having to click on the readme button
k
Not at the moment, and that would require changes in the backend to support
Would a README preview of two sentences work for you? Maybe we can make a feature request for it
h
Yea that would be awesome! One idea could be adding like a ? icon and if a user hover over it, it pops up a summary of what the flow does
And readme can still be used for full documentation
k
That sounds pretty good to me though I don’t know the technical details. Could you a feature request in the UI repo ?
c
is the readme purely in the "server" or "cloud", or can it be part of the flow code itself? seems like that'd be best to have it stored with the code itself, rather than separately.
k
In Orion (Prefect 2.0), it can be pulled from the Flow docstring. For current Prefect, you would have to use the API. Someone posted about a tool they created recently. Let me look for it
c
neat, thanks!