#92, add docs informaiton for comment feature

Steem-FOSSbot · Apr 15, 2018 · 4b8eaf8 · 4b8eaf8 · prosmacs · Apr 15, 2018
1 parent bbd57f0
commit 4b8eaf8
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ The operations you can perform are:
 
 - Run bot now (WILL VOTE)
 - Check bot stats (this is pretty cool)
-- Edit curation algorithm weights and white / black lists
+- Edit curation algorithm weights and white / black lists, set comment
 - Edit configuration and settings of bot
 - Run algorithm test (does not actually vote)
 - View last log

diff --git a/docs/dashboard-overview.md b/docs/dashboard-overview.md
@@ -137,10 +137,11 @@ In order for the bot to function _at all_, you must set your algorithm for it. T
 
 For a more detailed explanation, see the [algorithm doc](/docs/algorithm.md).
 
-To summarise, there are two parts to the algorithm:
+There are several parts to the algorithm:
 
 - A collection of weights
 - Some white / blacklists
+- Comment to make on voted posts (optional)
 
 #### Weights
 
@@ -166,6 +167,14 @@ _Edit Algorithm, top of page_
 
 ![](/img/edit-algo-1.png)
 
+#### Comment
+
+Optionally you can set the bot to comment on every post you vote for. This must be plain text but can include any normal characters as well as unicode, so there is support for emoji and the characters of the world's languages.
+
+To enable this feature you must set the text here and also turn it on in the configuration variable. Go to Edit Config to set this.
+
+![](/img/edit-algo-comment.png)
+
 #### Features
 
 - Clicking a metric name in the reference list at the bottom of the page will add that metric to the top metric update form, for ease of use

diff --git a/img/edit-algo-comment.png b/img/edit-algo-comment.png