[ANNOUNCE] doc-red

Share Your Nodes
1

If you ever wanted a plugin that displays an icon in case you have documentation on your node, the time has come. We proudly announce doc-red.

It also gives you a sidebar where all todos are listed and has some nice features like auto-documentation of outputs.

Please enjoy and let us know whether you like this plugin or not.

Cheers
Chris

2

As per the other thread, would be great if you could update to target node.js versions of 18+ rather than specific versions which currently exclude v20 which I'm running and so I can't use the node I'm afraid.

3

More details on this plugin and some screenshots can be found in this thread.

image
image440Ă—441 16.1 KB

4

As in the other thread mentioned we cannot reproduce that problem. We use node v20.18.0 and exclude only lower than v14.

"engines": {
    "node": ">=14.0"
  }

doc-red has also no dependencies (1 dev dependency). We installed it via cli and via node-red manager on a fresh system in gitpod and on a local machine without problems.

5

OK, thanks, probably my dev setup then which doubtless needs some tidying up!

6

Recently found this and like it.
Any particular reason this is not available for groups?
I understand they don't have input/outputs, but the #todo and signal of the presence of documentation would be nice.

7

Hi Jow,

glad to hear, that there are more users finding this plugin useful.

I'm just not sure if I get your point. You can add Todos and Docs like in nodes, groups and even tabs.

image
image782Ă—489 59.1 KB

The current version is 1.6.0, please check if you use for some reasons an older version.

Otherwise please open a ticket in the git.

8

My bad. I assumed it didn't work because I didn't see the faint document icon in the left hand upper corner when you hover a group's edge when there's no documentation present.

It does work, except for the hover.
Thanks.

9

No problem.
The hovered doc icon should also exist. It may is a bit difficult to find.
If I find the time I will change that the icon will also be shown if the group is hovered.
Then it has the same behaviour like nodes and tabs.

image
image435Ă—234 15.6 KB

10

Ha, I never even noticed the option for the "dummy" icon on hover. I've just turned it on and it is very useful! Many thanks for this contribution.

11

I can't however get the comments on every output of let's say a switch node to display. In the example comments of output 2 and 4 are skipped for some reason.

[
    {
        "id": "33a14c537ed9f895",
        "type": "switch",
        "z": "fa65a577079c6019",
        "name": "MySwitch",
        "property": "payload",
        "propertyType": "msg",
        "rules": [
            {
                "t": "eq",
                "v": "een",
                "vt": "str"
            },
            {
                "t": "eq",
                "v": "twee",
                "vt": "str"
            },
            {
                "t": "eq",
                "v": "drie",
                "vt": "str"
            },
            {
                "t": "eq",
                "v": "vier",
                "vt": "str"
            },
            {
                "t": "eq",
                "v": "vijf",
                "vt": "str"
            }
        ],
        "checkall": "true",
        "repair": false,
        "outputs": 5,
        "x": 460,
        "y": 540,
        "wires": [
            [
                "749f208e8c71afaa"
            ],
            [
                "8f257bcd375e619f"
            ],
            [
                "c9bb9edd93098baa"
            ],
            [
                "24b894b563d63ea4"
            ],
            [
                "7dd07183bbd3b497"
            ]
        ],
        "inputLabels": [
            "sin"
        ],
        "outputLabels": [
            "sout1",
            "sout2",
            "sout3",
            "sout4",
            "sout5"
        ],
        "info": "# Inputs\r\nGeneral input comment\r\n## sin\r\nde ingang\r\n# Outputs\r\nGeneral output comment\r\n## sout1\r\ntesting out 1\r\n## sout2\r\ntest 2\r\n## sout3\r\ntesting out 3\r\n## sout4\r\nlijn 4\r\n## sout5\r\nvijf"
    },
    {
        "id": "749f208e8c71afaa",
        "type": "debug",
        "z": "fa65a577079c6019",
        "name": "debug 15",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 620,
        "y": 440,
        "wires": []
    },
    {
        "id": "8f257bcd375e619f",
        "type": "debug",
        "z": "fa65a577079c6019",
        "name": "debug 16",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 620,
        "y": 480,
        "wires": []
    },
    {
        "id": "c9bb9edd93098baa",
        "type": "debug",
        "z": "fa65a577079c6019",
        "name": "debug 17",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 620,
        "y": 540,
        "wires": []
    },
    {
        "id": "24b894b563d63ea4",
        "type": "debug",
        "z": "fa65a577079c6019",
        "name": "debug 18",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 620,
        "y": 580,
        "wires": []
    },
    {
        "id": "7dd07183bbd3b497",
        "type": "debug",
        "z": "fa65a577079c6019",
        "name": "debug 19",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 620,
        "y": 640,
        "wires": []
    },
    {
        "id": "7548e9ecb37c9176",
        "type": "inject",
        "z": "fa65a577079c6019",
        "name": "",
        "props": [
            {
                "p": "payload"
            },
            {
                "p": "topic",
                "vt": "str"
            }
        ],
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "topic": "",
        "payload": "",
        "payloadType": "date",
        "x": 250,
        "y": 520,
        "wires": [
            [
                "33a14c537ed9f895"
            ]
        ]
    }
]

image
image651Ă—759 28.4 KB

# Inputs
General input comment
## sin
de ingang
# Outputs
General output comment
## sout1
testing out 1
## sout2
test 2
## sout3
testing out 3
## sout4
lijn 4
## sout5
vijf
12

This was indeed a bug.

Version 1.6.2 is out fixing this and if hovering on the group line the doc icon will also be shown.
(Showing it while hovering within the group needs some extra logic, which is currently only css and I'm not sure it will be more distracting to show the icon while beeing in the group)