frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Updated Node documentation guide (markdown)

Brian Innes 2016-12-13 12:05:55 +00:00
parent bd3d9a95af
commit 0b4d84b6d5
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Node-documentation-guide.md

@ -1,2 +1,23 @@
## Objective:
Create a style guide for node creators, so the node documentation in the Info tab follows a consistent format and style to allow Node-RED users to more easily be able to use new nodes.
# Objective:
Create a style guide for node creators, so the node documentation in the Info tab follows a consistent format and style to allow Node-RED users to more easily be able to use new nodes.
##Pallet:
Best practices round icon, colour name and section, so pallet is easy to use and nodes all look consistent.
##Documentation:
The Info tab displays documentation for the selected node. The following format is suggested to create uniform node documentation.
###Short Description
The first paragraph should be a short description, which is also used for the hover over text when hovering over nodes in the pallet. The first paragraph needs to work for both the Info tab and also the hover over text. The content should provide short description of the primary function of the node.
###Description
After the short description the documentation should give a fuller description of what the node does.
###Configuration
All configuration parameters should be described fully, including any incoming msg properties that override the default configuration.
###Output
Document all outgoing properties that are set of modified by the node.
###External reference
If the node is an interface for an external system or protocol then a link to the relevant home page or similar site should be provided.