From 45c33f36d101817fe3dbd3e1c8b954f2a81c3603 Mon Sep 17 00:00:00 2001 From: BekahHW <34313413+BekahHW@users.noreply.github.com> Date: Fri, 6 Sep 2024 11:22:05 -0400 Subject: [PATCH] chore: codeowners revise chrome instructions (#387) * Revise latest chrome ext highlight instructions * Add admonition in hot and point users to explore * Add space to admonitions Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com> --------- Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com> --- .../chrome-extension/code-explanation.md | 19 -------- docs/tools/chrome-extension/highlights.md | 8 +--- docs/tools/chrome-extension/pr-description.md | 47 ------------------- .../refactoring-and-testing.md | 27 ----------- docs/tools/hot-opensauced.md | 6 +++ sidebars.js | 18 ------- 6 files changed, 8 insertions(+), 117 deletions(-) delete mode 100644 docs/tools/chrome-extension/code-explanation.md delete mode 100644 docs/tools/chrome-extension/pr-description.md delete mode 100644 docs/tools/chrome-extension/refactoring-and-testing.md diff --git a/docs/tools/chrome-extension/code-explanation.md b/docs/tools/chrome-extension/code-explanation.md deleted file mode 100644 index e6fc4069..00000000 --- a/docs/tools/chrome-extension/code-explanation.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: code-explanation -title: "Code Explanation" -sidebar_label: "Code Explanation" -keywords: -- "ai" -- "code explanations" -- "Code Interpretation" -- "Programming Insights" -- "Code Understanding" -- "Code Walkthrough" -- "Algorithm Explanation" -- "Software Development Insights" -- "AI in Code" ---- - -Generate an explanation for a block of code 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 you reach the desired line. - -![generate code refactor](../../../static/gif/pr-code-explain.gif) diff --git a/docs/tools/chrome-extension/highlights.md b/docs/tools/chrome-extension/highlights.md index ffa58403..76a2f9fe 100644 --- a/docs/tools/chrome-extension/highlights.md +++ b/docs/tools/chrome-extension/highlights.md @@ -18,14 +18,10 @@ keywords: - "Highlighted Insights" --- -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. +If you're in GitHub, you can use the OpenSauced Chrome Extension to post a [highlight](highlights.md) of your pull requests to the OpenSauced website. -![location of post to highlight](https://user-images.githubusercontent.com/18273833/241761099-e7a745c8-204e-4a4d-b313-867ab99af0b2.png) +You can access the post to highlight it from the popup window in the extension. When you click it, it will automatically, populate the PR title and you can provide the summary. If your Highlight is successfully posted, you will get 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) - -But if there is an error with the summarization, you will see it in the text area, as in the example below: - -![Error message](https://user-images.githubusercontent.com/18273833/241762187-f6968a71-c344-495f-8eed-f1de9aff7599.gif) diff --git a/docs/tools/chrome-extension/pr-description.md b/docs/tools/chrome-extension/pr-description.md deleted file mode 100644 index b90b51dc..00000000 --- a/docs/tools/chrome-extension/pr-description.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: pr-description -title: "PR Description" -sidebar_label: "PR Description" -keywords: -- "ai" -- "pr descriptions" -- "pull request overview" -- "pr details" -- "pr review description" -- "Description Guidelines" -- "Contribution etiquette" -- "Pull Request Insight" -- "PR Context" -- "pull request description" ---- - -The OpenSauced Chrome extension will help you 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, the difference between the files, or both. You can even set the message's length and tone using the same settings. - -_**Note**: This feature is not available on private repositories._ - -![generate pr description](../../../static/gif/pr-description.gif) - -You can use these settings to set the strictness and the tone of the generated AI. Below is the explanation of the settings: - -- **Description Length**: The output length. -- **Temperature**: 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/tools/chrome-extension/refactoring-and-testing.md b/docs/tools/chrome-extension/refactoring-and-testing.md deleted file mode 100644 index 6c011c05..00000000 --- a/docs/tools/chrome-extension/refactoring-and-testing.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: refactoring-and-testing -title: "Refactoring and Testing" -sidebar_label: "Refactoring and Testing" -keywords: -- "refactoring" -- "testing" -- "refactoring and testing best practices" -- "how to refactor and test code" -- "benefits of refactoring and testing" -- "refactoring and testing tools" -- "refactoring and testing techniques" -- "refactoring and testing examples" -- "refactoring and testing tutorial" ---- - -## Refactoring a Block of Code - -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 you reach the desired line. - -![generate code refactor](../../../static/gif/pr-code-refactor.gif) - -## Testing a Block of Code - -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 you reach the desired line. - -![generate code refactor](../../../static/gif/pr-code-test.gif) diff --git a/docs/tools/hot-opensauced.md b/docs/tools/hot-opensauced.md index e3e53f30..e42a14e0 100644 --- a/docs/tools/hot-opensauced.md +++ b/docs/tools/hot-opensauced.md @@ -12,6 +12,12 @@ keywords: - "Popular GitHub Repositories" --- +:::danger + +This tool is deprecated. To discover open source projects to contribute to, check out the [OpenSauced Explore Page](https://app.opensauced.pizza/explore/topic/javascript). + +::: + [Hot OpenSauced](https://hot.opensauced.pizza/) is a site that helps you discover the hottest open source projects to contribute to. You also have the ability to vote for your favorite open source projects. ## How to Find Hot Open Source Projects to Contribute to? diff --git a/sidebars.js b/sidebars.js index ff46a7c5..65f53527 100644 --- a/sidebars.js +++ b/sidebars.js @@ -107,30 +107,12 @@ module.exports = { type: "category", label: "Using the Chrome Extension", items: [ - { - type: "file", - label: "feature 1", - type: "doc", - id: "tools/chrome-extension/code-explanation", - }, - { - type: "file", - label: "feature 2", - type: "doc", - id: "tools/chrome-extension/pr-description", - }, { type: "file", label: "feature 3", type: "doc", id: "tools/chrome-extension/highlights", }, - { - type: "file", - label: "feature 5", - type: "doc", - id: "tools/chrome-extension/refactoring-and-testing", - }, { type: "file", label: "feature 6",