From 0b4d84b6d50388eb7c4b94d1beabb217b9583dd5 Mon Sep 17 00:00:00 2001 From: Brian Innes Date: Tue, 13 Dec 2016 12:05:55 +0000 Subject: [PATCH] Updated Node documentation guide (markdown) --- Node-documentation-guide.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/Node-documentation-guide.md b/Node-documentation-guide.md index 28f97fb..980e7f5 100644 --- a/Node-documentation-guide.md +++ b/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. \ No newline at end of file +# 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. \ No newline at end of file