frodovdr
/
node-red
mirror of https://github.com/node-red/node-red.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Node documentation guide (markdown)

Brian Innes 2016-12-13 12:07:56 +00:00
parent 0b4d84b6d5
commit e1578a5dfd
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Node-documentation-guide.md

@ -5,9 +5,8 @@ Create a style guide for node creators, so the node documentation in the Info ta
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 Info tab displays documentation for the selected node. The following format is suggested to create uniform node documentation.
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