open-sauced / docs

OpenSauced documentation built with docusaurus
http://opensauced.pizza/docs
MIT License
78 stars 65 forks source link

Feature: Add a section for Key Metrics Guide #407

Closed BekahHW closed 2 weeks ago

BekahHW commented 1 month ago

Suggested solution

We have some Concepts at OpenSauced that I think are valuable but are getting lost in the other docs.

I would like to see a section for that called Key Metrics Guide.

It should include things like:

It doesn't need to be as thorough as Understanding Repo Insights Data, but this is a decent enough example to show that with the section, users can 1. Understand what those concepts mean and 2. Understand why they're useful.

It should go a little deeper than the glossary. Maybe be linked in the glossary, even.

BekahHW commented 1 month ago

@FatumaA go ahead and assign yourself if you're interested

FatumaA commented 1 month ago

.take

github-actions[bot] commented 1 month ago

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

BekahHW commented 1 month ago

Hey @FatumaA how are things going?

FatumaA commented 1 month ago

Hi Bekah! I will get to this in the next couple of days.

I did look at it and was going to put it under "Getting Started." Is that okay, or should it be in its own section right below the "contributing guide" section?

BekahHW commented 1 month ago

@FatumaA, you can put it under Getting Started. I like that idea.