-
Notifications
You must be signed in to change notification settings - Fork 60
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
Comments
Hi can i take this up? |
Hey @oluwatobi2001. Just type |
Thanks for taking this on! If you have not already, join the conversation in our Discord |
Thanks for taking this on! If you have not already, join the conversation in our Discord |
Hi @oluwatobi2001, are you still interested in working on this issue? |
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
<#224 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AGW7FFK6FZPFO5TSVBTL7S3ZF3JZLAVCNFSM6AAAAABAJXZWJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBZGMYDGMZQGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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. 🙂 |
Thanks @adiati98, I would love to take on this one :) |
.take |
Thanks for taking this on! If you have not already, join the conversation in our Community |
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. |
Hello @adiati98 ! 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! |
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." 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. |
Thanks @adiati98! Here's a possible draft for organizing the instructions:
What do you think? Any suggestions? |
Hey @vivitt, Sorry for taking a while to respond. This looks great! ✨
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. |
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
The text was updated successfully, but these errors were encountered: