When you want to start developing your custom Node-RED nodes, there is currently already a LOT of useful information available in the official documentation:
But I would like to add some extra stuff to it:
When I started Node-RED two years ago, this information was just not enough for me because:
- I needed to know the basics of NPM
- I needed to create my first Github repository
- I needed to publish my node on NPM
Just didn't knew where to get started, with all those technologies that were completely new for me. And I don't think I'm the only Node-RED user that has those kind of questions.
Question: is it ok if I create a pull request to add this kind of information to the developer Github page? I don't think users are going to find it, if I document it somewhere else on the dark net ...
The documentation contains nice code examples how to program something, but I would like to have some extra design guidelines on how to use it. E.g. not only explain how to update a node status, but also explain which kind of information is expected in the status (like Dave has nicely explained here). There are so many good design guidelines spread (and repeated) across the forum, but would be nice if this kind of information was also in the official documentation.
Question: is it ok if I create a pull request to add some of these design guidelines to the developer Github page?
When developing nodes, it is very handy to have an idea of how Node-RED technically works. For example which communication goes via webservices, and so on ...
Question: is it ok if I create a pull request to add some kind of technical diagram to the developer Github page? E.g. a diagram to show that both the flow editor and dashboard communicate via websocket to the flow.
And secondly there is the new https://github.com/node-red/node-red-ui-nodes , which is specific for UI development. But most of the information for ui-nodes is identical to the information of non-ui nodes ...
Question: Not sure at the moment which kind of information needs to be in this repository, instead of in the above developer documentation? Or do we need to repeat some of the information on both places.