From 2ec66007d9a5164fb88c0d394e43cba762765c5d Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Fri, 5 Apr 2019 21:42:17 +0000 Subject: [PATCH] feat: added docs for featured comments tab (#2259) --- plugins/talk-plugin-featured-comments/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/plugins/talk-plugin-featured-comments/README.md b/plugins/talk-plugin-featured-comments/README.md index be47eaf37..eb5e3e63e 100644 --- a/plugins/talk-plugin-featured-comments/README.md +++ b/plugins/talk-plugin-featured-comments/README.md @@ -16,4 +16,15 @@ if there are any featured comments on that story. When paired with the [talk-plugin-moderator-actions](/talk/plugin/talk-plugin-moderator-actions) plugin, moderators will have the option of featuring comments from the comment -stream. \ No newline at end of file +stream. + +## Default Comments Tab + +You can also change the default tab when rendering the comment stream to the +featured tab so when a user reaches a comment stream, they will see the featured +comments first by setting the [TALK_DEFAULT_STREAM_TAB](/talk/advanced-configuration/#talk-default-stream-tab) +variable to `talk-plugin-featured-comments`. + +This is a **Build Variable** and must be consumed during build. If using the +[Docker-onbuild](/talk/installation-from-docker/#onbuild) +image you can specify it with `--build-arg TALK_DEFAULT_STREAM_TAB=talk-plugin-featured-comments`.