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 section for key metrics guide #412

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

Conversation

FatumaA
Copy link
Contributor

@FatumaA FatumaA commented Oct 26, 2024

Description

This PR adds a key metrics guide section to the documentation.

Related Tickets & Documents

Fixes #407

Mobile & Desktop Screenshots/Recordings

N/A

Steps to QA

  1. Run the project locally
  2. Notice the new sidebar entry under the "Getting Started" section.
  3. See that all the mentioned metrics are covered.

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?

A gif of a black man on a purple backdrop in a white t-shirt looking at his wrist watch

@FatumaA FatumaA requested a review from a team as a code owner October 26, 2024 17:55
Copy link

netlify bot commented Oct 26, 2024

Deploy Preview for saucedocs ready!

Name Link
🔨 Latest commit 3793338
🔍 Latest deploy log https://app.netlify.com/sites/saucedocs/deploys/6721f60800161f0008ed7f7e
😎 Deploy Preview https://deploy-preview-412--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.

Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

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

This is really great, Fatuma. There are a couple of comments in the review.

We might want to add YOLO Coders as well. Here's more info on that: https://opensauced.pizza/blog/yolo-coder.

@FatumaA
Copy link
Contributor Author

FatumaA commented Oct 29, 2024

This is really great, Fatuma. There are a couple of comments in the review.

We might want to add YOLO Coders as well. Here's more info on that: https://opensauced.pizza/blog/yolo-coder.

Thank you. I've made the requested changes.

Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

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

It's almost there! Reading through it again, I think it makes more sense to use the third person instead of second person. We also want to make sure that the sections are written for a general audience (including teams, maintainers, and contributors) and not just contributors.

@FatumaA
Copy link
Contributor Author

FatumaA commented Oct 30, 2024

so want to make sure that the sections are written for a general audience (including teams, maintainers, and contributors) and not just contributors.

Makes sense! Done 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add a section for Key Metrics Guide
3 participants