From e1578a5dfd6e1198303eadc4b1c446b2f1bda1ab Mon Sep 17 00:00:00 2001 From: Brian Innes Date: Tue, 13 Dec 2016 12:07:56 +0000 Subject: [PATCH] Updated Node documentation guide (markdown) --- Node-documentation-guide.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Node-documentation-guide.md b/Node-documentation-guide.md index 980e7f5..c25fcbe 100644 --- a/Node-documentation-guide.md +++ b/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