How to Add a Markdown Comment Text Box in a Workflow for Documentation?

1

This topic was automatically generated from Slack. You can find the original thread here.

I just had a thought. I wanted to document or put a comment in my workflow. It might be nice to have a markdown comment text box that can be added at the top or inline on a workflow. The sole purpose is to write and comments or text for future self or other team members.

For now I put a python block, write my comments, move it to the step after the trigger and then disable the step.

2

Hi ; thank you for the suggestion! Actually, that is on the roadmap right now: https://github.com/PipedreamHQ/pipedream/issues/7471.

Please subscribe to the ticket to be noticed when it is implemented!

3

Cool. I will. Thank you.

4

Hey Tim, we agree! We have a working prototype internally that we’re working to get over the line :grinning:

5

Posted thread to Discourse: Is There a Markdown Comment Text Box Feature for Documenting Workflow?

6

FYI we shipped step notes! Please let me know if you have any feedback Steps