PrefectHQ
Improve formatting for code snippets in the readme/flow description
Opened from the Prefect Public Slack Community
jacobo.blanco: Hey folks, just wanted to that the README functionality in the UI is a huge boost to data scientists being able to do stuff self-service, and it would be really helpful to see the feature developed. I’m not a frontend person otherwise I’d help. Some ideas: • Better formatting. Right now, no offense, it’s a bit janky. Code snippets in particular. • I’d like to be able to set the documentation when registering the flow so that we can have the same flow deployed in staging and production as well as ensure that changes to code and docs are co-located. • I’d like to be able to setup examples of flow run parameters in the docs and have users of flows run the example directly from the docs.
jenny: Hi <@UQVJQAK5H> - Thanks for the suggestions. There's <https://github.com/PrefectHQ/prefect/issues/4154|an issue in the Core repo> for setting a readme at flow registration - we're definitely aware of that as a feature request but you can add comments there to show your interest. The formatting for code-snippets is something the UI team can look into - I'll open a ticket below you can add any more details about what you are currently seeing and what you'd like to see.
jenny: <@ULVA73B9P> open "Improve formatting for code snippets in the readme/flow description" in UI
Original thread can be found here.
The UI relevant part of the above is the section about code snippets. Can we add better formatting to improve the UX there?
