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: Update Highlights docs #224

Open
3 of 4 tasks
BekahHW opened this issue Dec 6, 2023 · 16 comments · May be fixed by #344
Open
3 of 4 tasks

feat: Update Highlights docs #224

BekahHW opened this issue Dec 6, 2023 · 16 comments · May be fixed by #344
Assignees

Comments

@BekahHW
Copy link
Member

BekahHW commented Dec 6, 2023

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 #213 (comment)

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
Copy link

Hi can i take this up?

@CBID2
Copy link
Contributor

CBID2 commented May 27, 2024

Hi can i take this up?

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

Copy link

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

@CBID2 CBID2 removed their assignment May 27, 2024
Copy link

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

@vivitt
Copy link

vivitt commented Jun 5, 2024

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

@oluwatobi2001
Copy link

oluwatobi2001 commented Jun 5, 2024 via email

@adiati98
Copy link
Member

adiati98 commented Jun 6, 2024

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
Copy link

vivitt commented Jun 12, 2024

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

@vivitt
Copy link

vivitt commented Jun 12, 2024

.take

Copy link

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

@vivitt
Copy link

vivitt commented Jun 14, 2024

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:
gif_01

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

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
Copy link
Member

adiati98 commented Jun 14, 2024

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
Copy link

vivitt commented Jun 17, 2024

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
Copy link
Member

adiati98 commented Jun 19, 2024

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
Copy link

vivitt commented Jun 21, 2024

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
Copy link
Member

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.

@vivitt vivitt linked a pull request Jun 27, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants