I don't document much in node red (or enough), but when I do, it's not easily visible. And because I do it so rarely, and perhaps I'm not alone here, I don't really expect to look for documentation. Which means any descriptions I add to a node is easily forgotten and not revisited as much as I should.
Would it be possible to have a small info icon/emblem somewhere on the node to notify that it got text in the description tab? Perhaps even make it optional toggle on/off per user. Of course GUI is easily cluttered and already quite busy at times, so take it with a grain of salt.
Noticed other nodes like inject got nice tiny symbols to indicate some details, like repeat.
This is just something I notice that is easy to forget and overlook.
I'm using doc-red and it is super helpful in remembering which nodes/groups/flows have additional documentation. Not perfect perhaps but definitely useful.
Yeah it almost solves my entire problem. One minor inconvenience is that it also marks a a node if that is a subflow and the subflow has documentation (in the tab). I almost always document subflows, as their interface is reused and thus more important than any individual node.
If it is not perfect yet, do you have any suggestions for improvement?
@ThingsTinkerer
If I understand you correctly, you have documentated your main subflow but don't want to see the documentation icon on the flow node in the workspace? If so, I will discuss that intern and am sure that we can find a solution here.
Nothing specific right now. I think that we sometimes see slight overlaps or misalignment. Not really surprising given the tightness of the visual layout of Node-RED. Obviously, further integration with NR's core might well improve that. I know how tricky such visual layouts can be though so please don't think I'm criticising.
