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 shoul…

Wow, thanks, already a plugin for it! Must try... [image] doc-red A plugin for Node-RED which helps to documentate and enhance your workspace.

We also have this PR to the editor that adds the info icon to nodes; just undecided if we want to add it it not. Add a node annotation if the info property is set dev ← add-doc-annotation opened 09…

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.

Thanks for the commendation. If it is not perfect yet, do you have any suggestions for improvement? :wink: @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 t…

[image] meijey: If it is not perfect yet, do you have any suggestions for improvement? 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'…

Awesome! The node red experience becomes even better.

Node-RED

Node-RED Forum

Info icon for nodes with description?

Core Development Feature Requests

dceejay 17 March 2025 03:46 2

See also this thread Special indication on nodes with description

Topic		Replies	Views
What "addon" is it so you can put notes on nodes/groups/etc? General	8	101	7 June 2025
Indication Icon for Nodes where a description text is entered Feature Requests	5	609	2 December 2023
Special indication on nodes with description Feature Requests feature-request	139	2009	20 November 2025
Improved node documentation icon General	9	137	2 November 2025
Ways to improve flow documentation Feature Requests	29	510	16 February 2026

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

Info icon for nodes with description?

Related topics