Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add instructions for Highlights Suggestions section #344

Merged
merged 3 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions docs/features/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
id: highlights
title: "Highlight Your Open Source Contributions"
sidebar_label: "Highlights"
keywords:
- "Highlights"
- "Open Source Highlights"
- "Contribution Highlights"
- "Highlight your open source contributiions"
- "Open Source Contribution Highlights"
keywords:
- "Highlights"
- "Open Source Highlights"
- "Contribution Highlights"
- "Highlight your open source contributiions"
- "Open Source Contribution Highlights"
---

The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors.
Expand All @@ -20,13 +20,30 @@ There are currently three types of highlights you can add to your profile:

## How to Add a Highlight

- Go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed).
- Click the "Post a highlight to show your work!" input.
First, go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed), then click the "Post a highlight to show your work!" input.

There are two ways to adding highlights:

### 1. Using Highlight Suggestions

- Search the pull request or issue that you want to add in the "Highlight suggestions" section.
- Click the "Fill content" button to paste the suggested link or the "Add and Summarize" button to paste the link and auto-summarize the content.

![highlights demo](../../static/gif/highlight.gif)

:::note

The "Highlight suggestions" are only suggesting issues and pull requests that you created. For blog posts, you need to add them manually.

:::

### 2. Adding a Link Manually

- Paste the URL to your blog post, pull request, or issue in the bottom input.
- Either use our Auto-Summarize feature or write your own summary.

![highlights demo](../../static/gif/highlight.gif)
---

For more examples of highlights, go to the [OpenSauced Highlights feed](https://app.opensauced.pizza/feed).

Eager to get started? Check out the [Effectively Highlight Your Contribution](https://opensauced.pizza/learn/#/06-the-secret-sauce?id=effectively-highlight-your-contributions) section in our free "Intro to Open Source" course to learn more.
Eager to get started? Check out the [Effectively Highlight Your Contribution](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions) section in our free "Intro to Open Source" course to learn more.
vivitt marked this conversation as resolved.
Show resolved Hide resolved
Binary file modified static/gif/highlight.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading