From bfed4ba324d6207f40d18296c05d445453a7a529 Mon Sep 17 00:00:00 2001
From: Penar Musaraj <pmusaraj@gmail.com>
Date: Tue, 12 Oct 2021 10:11:29 -0400
Subject: [PATCH] UX: Add in:docs quick tip in search widget (#61)

---
 .../discourse/initializers/setup-docs.js.es6           | 10 +++++++++-
 config/locales/client.en.yml                           |  1 +
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/assets/javascripts/discourse/initializers/setup-docs.js.es6 b/assets/javascripts/discourse/initializers/setup-docs.js.es6
index 347097c..92c01fa 100644
--- a/assets/javascripts/discourse/initializers/setup-docs.js.es6
+++ b/assets/javascripts/discourse/initializers/setup-docs.js.es6
@@ -32,13 +32,21 @@ export default {
 
   initialize(container) {
     withPluginApi("0.8", (api) => initialize(api, container));
-    withPluginApi("0.11.7", (api) => {
+    withPluginApi("0.12.6", (api) => {
       const siteSettings = container.lookup("site-settings:main");
       if (!siteSettings.docs_enabled) {
         return;
       }
 
       api.addSearchSuggestion("in:docs");
+
+      const tip = {
+        label: "in:docs",
+        description: I18n.t("docs.search.tip_description"),
+        clickable: true,
+        searchTopics: true,
+      };
+      api.addQuickSearchRandomTip(tip);
     });
   },
 };
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index 2f44bd9..192d5a3 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -17,6 +17,7 @@ en:
           other: "%{count} results found"
         placeholder: "Search for topics"
         clear: "Clear"
+        tip_description: "Search in docs"
       topic:
         back: "Go back"
         navigate_to_topic: "View the discussion on this topic"