feat: Update Highlights docs

[BekahHW]

Current

We have "Fill content" and "Add and Summarize" buttons in the "Highlight suggestions" section that are not covered here.

Originally posted by @adiati98 in https://github.com/open-sauced/docs/pull/213#discussion_r1405228070

Solution

• [ ] add directions on adding a highlight from the highlight suggestion.
• [ ] Explain both the "Fill content" and "Add and Summarize" buttons
• [ ] Remove the existing gif for the highlight
• [ ] Create a new gif with one that shows the suggestions and name it "highlight.gif". (The naming is important so we don't break anything that's been linked elsewhere.)

[oluwatobi2001]

Hi can i take this up?

[CBID2]

Hi can i take this up?

Hey @oluwatobi2001. Just type .take in the comment section and you'll be automatically assigned.

[github-actions[bot]]

Thanks for taking this on! If you have not already, join the conversation in our Discord

[github-actions[bot]]

Thanks for taking this on! If you have not already, join the conversation in our Discord

[vivitt]

Hi @oluwatobi2001, are you still interested in working on this issue? If not, I would like to take it. Let me know. Thanks!

[oluwatobi2001]

Yes, I'm still interested.

On Wed, Jun 5, 2024 at 10:19 AM Viviana Yanez @.***> wrote:

Hi @oluwatobi2001 https://github.com/oluwatobi2001, are you still interested in working on this issue? If not, I would like to take it. Let me know. Thanks!

— Reply to this email directly, view it on GitHub https://github.com/open-sauced/docs/issues/224#issuecomment-2149303301, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGW7FFK6FZPFO5TSVBTL7S3ZF3JZLAVCNFSM6AAAAABAJXZWJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBZGMYDGMZQGE . You are receiving this because you were mentioned.Message ID: @.***>

[adiati98]

Hi @oluwatobi2001,

Please read our contributing guidelines. If you want to work on this issue, please assign yourself to the issue. If this issue is still not assigned by next Monday, let's give it to someone else who's interested. 🙂

[vivitt]

Thanks @adiati98, I would love to take on this one :)

[vivitt]

.take

[github-actions[bot]]

Thanks for taking this on! If you have not already, join the conversation in our Community

[vivitt]

Hello! I have a couple of questions before submitting a PR for this issue:

First, I understand that this change should prioritize the Highlight suggestions section usage, so the current indications should remain in the docs but maybe below the new instructions and the new gif. Do you think this approach is correct, or does anyone have any other thoughts on this?

Second, I encountered an issue while using the "Add and summarize" button. As shown in the gif below, I receive an error message when I try to summarize a PR:

I am also not able to use the Auto-Summarize feature if I paste the link manually:

So I wanted to check if I am following the right steps here or if I am missing something.

Thanks a lot for any help :)

[adiati98]

Hey @vivitt,

Sorry, I don't quite understand what do you mean in the first question. Can you clarify it for me?

As for your question about auto-summarize, I can confirm that I also have the same issue. You might want to create an issue on our app repo to report this if there is no similar issue available. 😊

[vivitt]

Hello @adiati98 ! Didn't find a similar open issue, so I created one.

For my first question, I was confused because the How to Add a Highlight section now includes a set of bullet points and a GIF that need to be replaced. My bad for not explaining that clearly.

What I wanted to know is if should I document the "Fill Content" and "Add and Summarize" buttons by adding more bullet points below the existing ones, or is it better to reorganize the section by first documenting the "Highlight Suggestions" buttons and then the option of manually pasting a link?

Thanks!

[adiati98]

Hey @vivitt,

I think reorganizing would be better.

We can say something like, "There are two ways to add highlights, with the Highlight suggestions and manually." Then, follow the checkbox on the issue.

The instructions are all in bullet points for better read and understanding.

You can draft it first, and we'll see how we can improve and clarify them. And feel free to let me know if you have further questions or need help. ✨

[vivitt]

Thanks @adiati98! Here's a possible draft for organizing the instructions:

## How to Add a Highlight

There are two ways to adding highlights:

### Using Highlight Suggestions

- Go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed).
- Click the "Post a highlight to show your work!" input.
- Search the relevant blog post, pull request, or issue in the "Highlight suggestions" section.
- Either use 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](highlight.gif)

### Adding a Link Manually

- Go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed).
- Click the "Post a highlight to show your work!" input.
- 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.

What do you think? Any suggestions? Thanks :)

[adiati98]

Hey @vivitt,

Sorry for taking a while to respond.

This looks great! ✨ However, I can see a room for improvement based on below things:

• The first two bullet points in each method are the same. We might be able to avoid repetition here.
• The "Highlight suggestions" only suggest issue and PRs, not blog posts.

Below is a raw suggestion. Feel free to give other ideas.

## How to Add a Highlight

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.

:::note

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

:::

![highlights demo](highlight.gif)

### 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.