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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

vivitt
Copy link

@vivitt vivitt commented Jun 27, 2024

Description

This PR adds instructions to use the Highlight Suggestions section when adding a highlight.

It adds two sub sections below the "How to Add a Highlight". One for adding a highlight with suggestions and the second for adding it manually.

It also updates the highlight.gif with a new one that shows that shows the suggestions.

Related Tickets & Documents

Closes #224

Mobile & Desktop Screenshots/Recordings

This is how the Highlights docs looks after changes:

Screenshot 2024-06-28 at 13 08 07 Screenshot 2024-06-28 at 13 08 28

Steps to QA

  1. Use your preferred method to fetch the changes from the highlight-suggestions branch
  2. Start the local server and navigate to http://localhost:3000/features/highlights/
  3. Review updates in the "How to Add a Highlight" section

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] What gif best describes this PR or how it makes you feel?

@vivitt vivitt requested a review from a team as a code owner June 27, 2024 08:37
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Compliance Checks Passed!

Copy link

netlify bot commented Jun 27, 2024

Deploy Preview for saucedocs ready!

Name Link
🔨 Latest commit bc507b9
🔍 Latest deploy log https://app.netlify.com/sites/saucedocs/deploys/667e64eb432edd0008391621
😎 Deploy Preview https://deploy-preview-344--saucedocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@vivitt vivitt changed the title Add instructions for Highlights Suggestions section docs: add instructions for Highlights Suggestions section Jun 27, 2024
@vivitt vivitt changed the title docs: add instructions for Highlights Suggestions section feat: add instructions for Highlights Suggestions section Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: Update Highlights docs
2 participants