Automatic doc generation

General
1

hi to everybody,

is there a way to automatically generate documentation of a flow from its structure and the descriptions inside the modules and/or comments?

(sorry if the question is so basic, I am quite new with node-red)

Thanks in advance

2

As far as I know, this is not possible.

However, you can give nodes a "name" - if you make this verbose/descriptive, you can create self-describing flows.

SCR-20220906-ep3
SCR-20220906-ep32000Ă—312 43.9 KB

3

Along with that, you can use comment nodes and use groups to put a set of nodes that describe a process into a group with a bounding box and a title. So between all of those things it is possible to create flows that can be printed to a PDF and will still be understandable.