feedback icon indicating copy to clipboard operation
feedback copied to clipboard

[Docs Update] "Common Configurations" Page is really messy

Open ajay-sentry opened this issue 1 year ago • 2 comments

Description

It's hard to parse and understand all the "common configurations" possible, but its so, so helpful once we actually read through it.

I think if those settings were available on a "YAML Configuration" page with explicit values that we can put, it would likely be much easier to follow and lead to similar results. We could still have "recipes" like in this page, but it would also give an overview

Page(s)

https://docs.codecov.com/docs/common-recipe-list

Current State

[] Broken Link [X] Unclear Language [] Inconsistent Formatting [] Missing Information [] Missing Updates for New Features [] Deprecated Features

Additional Information

ajay-sentry avatar May 30 '24 17:05 ajay-sentry

I think this is a good suggestion. It makes sense to me to have a page of Common configurations with a short summary of the configuration itself then link to a separate page that gives the YAML / more details.

This should probably be its own subsection in the sidebar, it would also be easier to add more configurations this way when/if the need so arises.

eliatcodecov avatar Jul 24 '24 15:07 eliatcodecov

Amongst Docs issues, I consider this high priority because I think a restructuring of this page to make it more readable and user friendly could have extremely high ROI.

eliatcodecov avatar Jul 24 '24 16:07 eliatcodecov