Workflow description / documentation field

The idea is:

Provide a free-text (Markdown?) field to let the workflow author(s) provide a short description / overview of what the workflow does, and how the general flow is structured.

This would be particularly useful for organizations where multiple users might want to work on the same workflows and will need to maintain some basic documentation.

Today, the closest we have is the Notes field on every node, but it’s fairly limited (short, no formatting, not very visible, not workflow-level).

One possible design is to show, next to the workflow’s tags list, an (i) icon that would pop up a markdown display (with an edit button/mode).

I think it would be beneficial to add this because:

It helps users keep a short doc / explanation of their workflows.

Any resources to support this?

Are you willing to work on this?

Maybe - I’ve already contributed some nodes… but I don’t have very good UI skills.

Hey @Yann_Jouanique,

Maybe the new notes feature released today would do this for you. Here is what one of my personal workflows looks like with some notes around it.

4 Likes

Fantastic! Yes I think that’s quite what we need. Just upgraded, works really well…
Thanks!

3 Likes