feat: Adding subfolders to the using section for Chrome Extension (op…

…en-sauced#123)
Lymah123 · Jul 28, 2023 · a785c55 · a785c55
1 parent 7ba6cbd
commit a785c55
Show file tree

Hide file tree

Showing 8 changed files with 187 additions and 162 deletions.
diff --git a/docs/chrome-extension/code-explanation.md b/docs/chrome-extension/code-explanation.md
@@ -0,0 +1,12 @@
+---
+id: code-explanation
+title: 'Code Explanation'
+sidebar_label: 'Code Explanation'
+keywords:
+  - ai
+  - code explanations
+---
+
+Generate an explanation for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.
+
+![generate code refactor](../../static/gif/pr-code-explain.gif)
diff --git a/docs/chrome-extension/highlights.md b/docs/chrome-extension/highlights.md
@@ -0,0 +1,20 @@
+---
+id: highlights 
+title: 'Highlight'
+sidebar_label: 'Highlight'
+keywords:
+  - highlights
+  - posting
+---
+
+You can access the post to highlight it from the popup window in the extension. When you clicked, it will automatically, populate the PR or issue title, here you can use our AI functions to get a summary of the highlight similar to the PR summary. 
+
+![location of post to highlight](https://user-images.githubusercontent.com/18273833/241761099-e7a745c8-204e-4a4d-b313-867ab99af0b2.png)
+
+If you post a successful highlight it will show you a message with an option to see the highlight on the OpenSauced website. 
+
+![Successful message example](https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/723ac624-e996-45f8-acdf-0d3ff08af90b)
+
+If you presented with an error with the summarization, it will be printed in the text area. Here's an example:
+
+![Error message](https://user-images.githubusercontent.com/18273833/241762187-f6968a71-c344-495f-8eed-f1de9aff7599.gif)
diff --git a/docs/chrome-extension/pr-description.md b/docs/chrome-extension/pr-description.md
@@ -0,0 +1,39 @@
+---
+id: pr-description
+title: 'PR Description'
+sidebar_label: 'PR Description'
+keywords:
+  - ai
+  - pr descriptions
+---
+
+This will help you to create a PR based on the configuration you have in the extension, it will enable you to create the summary based on either **Commit Messages** or **The diff between the files** or **both**, you can even set the length and the tone of the message using the same settings.
+
+_Note: This feature is not available on private repositories._
+
+![generate pr description](../../static/gif/pr-description.gif)
+
+You can use this settings to set the strictness and the tone of the generated AI, here is an explanation of those settings:
+
+- **Description** length:The output length.
+- **Temperature**: Is the similarity between the input text and the output, higher temperature mean more randomness, lower temperature means more strict to the input.
+- **Max Input length.**
+- **Description language:** right now this feature supports: English, Spanish, French, German, Italian, Portuguese, Dutch, Russian, Chinese, Korean.
+- **Description tone:** The tone of the output: Exciting, Persuasive, Informative, Humorous, Formal
+- **Description source:** The source of the description that our AI will use to get the output it can be the next:**Commit Messages** or **The diff between the files** or **both**
+
+![Setting screenshot](https://user-images.githubusercontent.com/18273833/241760972-aa10eabe-3c01-4921-956a-ab85bada1575.png)
+
+![ezgif-3-43e056fc1f](https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/fa19fa8e-e652-461c-8df4-6e959c9b9943)
+
+[Example PR](https://github.com/open-sauced/insights/pull/1197), using the next options: both in the description source, 500 for output length and 3900 max input length, temperature 0.7.
+
+**Exciting:** This PR fixes the follow call and adds a FollowUser function to the contributor-highlight-card. The code has been linted and merged from the beta branch. FollowUser function allows users to follow/unfollow contributors. Copy link and follow/unfollow options are now available in the dropdown menu.
+
+**Persuasive:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. It also merges the `beta` branch into `fix-follow-check`. A new `FollowUser` function has been added to handle follow/unfollow functionality. This PR ensures a smoother user experience.
+
+**Informative:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. A new function `FollowUser` has been added to handle the follow/unfollow functionality. The `useFollowUser` hook has been moved inside this function. The `FollowUser` function is now used in place of the previous follow/unfollow code block. The code has been tested and reviewed.
+
+**Humorous:** This PR fixes the follow call and also lints the file. We've also added a new FollowUser function to make the code more readable. Now you can follow/unfollow contributors with ease. We've also merged the beta branch into fix-follow-check.
+
+**Formal:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. A new function `FollowUser` has been added to handle the follow/unfollow functionality. The `useFollowUser` hook has been moved inside this function. The `FollowUser` function is now used in place of the previous follow/unfollow code block. This PR also merges the `beta` branch into `fix-follow-check`.
diff --git a/docs/chrome-extension/quick-access-to-opensauced-links.md b/docs/chrome-extension/quick-access-to-opensauced-links.md
@@ -0,0 +1,10 @@
+---
+id: opensauced-links
+title: 'Code Explanation'
+sidebar_label: 'Quick Access to OpenSauced'
+keywords:
+  - opensauced
+  - links 
+---
+
+![Quick Access to OpenSauced](../../static/img/extension-links.png)
diff --git a/docs/chrome-extension/refactoring-and-testing.md b/docs/chrome-extension/refactoring-and-testing.md
@@ -0,0 +1,16 @@
+---
+id: refactoring-and-testing
+title: 'Refactoring and Testing'
+sidebar_label: 'Refactoring and Testing'
+keywords:
+  - refactoring
+  - testing 
+---
+
+Refactor a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.
+
+![generate code refactor](../../static/gif/pr-code-refactor.gif)
+
+Generate tests for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.
+
+![generate code refactor](../../static/gif/pr-code-test.gif)
diff --git a/docs/chrome-extension/using-the-chrome-extension.md b/docs/chrome-extension/using-the-chrome-extension.md
diff --git a/docs/chrome-extension/viewing-insights-and-invitations.md b/docs/chrome-extension/viewing-insights-and-invitations.md
@@ -0,0 +1,23 @@
+---
+id: viewing-insights-and-invitations
+title: 'Viewing Insights and Invitations'
+sidebar_label: Insights and Invitations'
+keywords:
+  - github
+  - insights and invitations
+---
+View stats about open issues, PRs made, average PRs velocity, and contributed repos that are in the OpenSauced database. This page can be found by clicking the profile picture at the top left of the extension.
+
+![GitHub Profile Insights](../../static/img/extension-popup.png)
+
+### Invite GitHub users to join OpenSauced with a single click
+
+Invite other users to create an OpenSauced account to keep track of open source contributions when visiting their GitHub profile.
+
+![Invite GitHub Users](../../static/img/extension-invite.png)
+
+### View GitHub users' OpenSauced profiles and connect with them
+
+View a user’s OpenSauced profile when on their GitHub profile page.
+
+![View OpenSauced Profiles](../../static/img/extension-view.png)
diff --git a/sidebars.js b/sidebars.js
@@ -1,4 +1,3 @@
-
 /**
  * Creating a sidebar enables you to:
  - create an ordered group of docs
@@ -12,59 +11,95 @@
 
 module.exports = {
   docs: [
-    'introduction',
+    "introduction",
     {
-      type: 'category',
-      label: 'Getting started',
+      type: "category",
+      label: "Getting started",
       collapsed: false,
       items: [
-        'community/welcome-to-the-community',
-        'community/highlights',
-        'community/100-days-of-oss',
-        'community/faqs'
+        "community/welcome-to-the-community",
+        "community/highlights",
+        "community/100-days-of-oss",
+        "community/faqs",
       ],
     },
     {
-      type: 'category',
-      label: 'Contributing guide',
+      type: "category",
+      label: "Contributing guide",
       collapsed: false,
       items: [
-        'contributing/introduction-to-contributing',
-        'contributing/code-of-conduct',
-        'contributing/triage-guide',
-        'contributing/set-up-authentication'
+        "contributing/introduction-to-contributing",
+        "contributing/code-of-conduct",
+        "contributing/triage-guide",
+        "contributing/set-up-authentication",
       ],
     },
     {
-      type: 'category',
-      label: 'Technical guide',
+      type: "category",
+      label: "Technical guide",
       collapsed: false,
-      items: [
-        'technical/introduction-to-storybook',
-        'technical/resolve-merge-conflicts',
-      ],
+      items: ["technical/introduction-to-storybook", "technical/resolve-merge-conflicts"],
     },
     {
-      type: 'category',
+      type: "category",
       label: `Maintainer guide`,
       collapsed: true,
       items: [
-        'maintainers/setting-up-a-new-repository',
-        'maintainers/check-engines',
-        'maintainers/conventional-commit',
-        'maintainers/semantic-release',
-      ]
+        "maintainers/setting-up-a-new-repository",
+        "maintainers/check-engines",
+        "maintainers/conventional-commit",
+        "maintainers/semantic-release",
+      ],
     },
     {
-      type: 'category',
-      label: 'Chrome Extension Usage',
+      type: "category",
+      label: "Chrome Extension Usage",
       collapsed: true,
       items: [
-        'chrome-extension/introduction-to-the-chrome-extension',
-        'chrome-extension/using-the-chrome-extension',
+        "chrome-extension/introduction-to-the-chrome-extension",
+        {
+          type: "category",
+          label: "Using the Chrome Extension",
+          items: [
+            {
+              type: "file",
+              label: "feature 1",
+              type: "doc",
+              id: "chrome-extension/code-explanation",
+            },
+            {
+              type: "file",
+              label: "feature 2",
+              type: "doc",
+              id: "chrome-extension/pr-description",
+            },
+            {
+              type: "file",
+              label: "feature 3",
+              type: "doc",
+              id: "chrome-extension/highlights",
+            },
+            {
+              type: "file",
+              label: "feature 4",
+              type: "doc",
+              id: "chrome-extension/opensauced-links",
+            },
+            {
+              type: "file",
+              label: "feature 5",
+              type: "doc",
+              id: "chrome-extension/refactoring-and-testing",
+            },
+            {
+              type: "file",
+              label: "feature 6",
+              type: "doc",
+              id: "chrome-extension/viewing-insights-and-invitations",
+            },
+          ],
+        },
       ],
     },
-
   ],
 };
-