feat: add chrome extension intro and usage to docs (#78)

* feat: add chrome extension intro and usage to docs * Update docs/chrome-extension/introduction-to-the-chrome-extension.md --------- Co-authored-by: Brian Douglas <[email protected]>
open-sauced · May 4, 2023 · 3597a93 · 3597a93
1 parent 7023b03
commit 3597a93
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 0 deletions.
diff --git a/docs/chrome-extension/introduction-to-the-chrome-extension.md b/docs/chrome-extension/introduction-to-the-chrome-extension.md
@@ -0,0 +1,15 @@
+---
+id: introduction-to-the-chrome-extension
+title: Introduction to the Chrome Extension
+sidebar_label: Introduction to the Chrome Extension
+keywords:
+  - introduction to the chrome extension
+---
+
+## The OpenSauced Chrome Extension
+
+The OpenSauced Chrome extension seamlessly integrates GitHub with the OpenSauced platform. With this extension, you can easily view and discover open-source projects looking for contributions directly from GitHub, making collaboration and contribution easier than ever.
+
+## Installing the Chrome Extension
+
+To install the OpenSauced Chrome extension, navigate to the [Chrome Web Store](https://chrome.google.com/webstore/detail/opensauced/aebjdjjodmkdnmejakflnfpkadblfmdh) and click the "Add to Chrome" button.
diff --git a/docs/chrome-extension/using-the-chrome-extension.md b/docs/chrome-extension/using-the-chrome-extension.md
@@ -0,0 +1,30 @@
+---
+id: using-the-chrome-extension
+title: Using the Chrome Extension
+sidebar_label: Using the Chrome Extension
+keywords:
+  - using the chrome extension
+---
+
+## Using the OpenSauced Chrome Extension
+
+The OpenSauced GitHub Profile Connector is a must-have extension for anyone who is passionate about open-source software and wants to contribute to the community. Whether you're an experienced maintainer or just getting started, this extension makes it easy to discover, contribute to, and track open-source projects on GitHub and connect with other developers who share your interests and skills.
+Here are some of the features that make the OpenSauced GitHub Profile Connector so useful:
+
+### View valuable insights about your GitHub profile
+
+<!-- image -->
+
+![GitHub Profile Insights](../../static/img/extension-popup.png)
+
+### Invite GitHub users to join OpenSauced with a single click
+
+![Invite GitHub Users](../../static/img/extension-invite.png)
+
+### View GitHub users' OpenSauced profiles and connect with them
+
+![View OpenSauced Profiles](../../static/img/extension-view.png)
+
+### Quick Access to important OpenSauced links
+
+![Quick Access to OpenSauced](../../static/img/extension-links.png)
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -91,6 +91,10 @@ module.exports = {
               label: 'Maintainer guide',
               to: '/maintainers/setting-up-a-new-repository/',
             },
+            {
+              label: 'Chrome Extension Usage',
+              to: '/chrome-extension/introduction-to-the-chrome-extension/',
+            }
           ],
         },
         {

diff --git a/sidebars.js b/sidebars.js
@@ -45,5 +45,14 @@ module.exports = {
         'maintainers/semantic-release',
       ]
     },
+    {
+      type: 'category',
+      label: 'Chrome Extension Usage',
+      collapsed: true,
+      items: [
+        'chrome-extension/introduction-to-the-chrome-extension',
+        'chrome-extension/using-the-chrome-extension',
+      ],
+    }
   ],
 };
diff --git a/static/img/extension-invite.png b/static/img/extension-invite.png
diff --git a/static/img/extension-links.png b/static/img/extension-links.png
diff --git a/static/img/extension-popup.png b/static/img/extension-popup.png
diff --git a/static/img/extension-view.png b/static/img/extension-view.png