mozilla / perfcompare

Improved Performance Comparison Tool
Mozilla Public License 2.0
39 stars 93 forks source link

PCF 434: Add documentation to ReadME #762

Closed Carla-Moz closed 1 week ago

Carla-Moz commented 3 weeks ago

I've completed writing the documentation for PerfCompare and think it would help to add it to our README. I'd like to get input from the whole team if possible. Thanks.

PerfCompare Documentation

netlify[bot] commented 3 weeks ago

Deploy Preview for mozilla-perfcompare ready!

Name Link
Latest commit b3ba2e0ca29d47db302228e533b44a46cafeb9a6
Latest deploy log https://app.netlify.com/sites/mozilla-perfcompare/deploys/66f70df5046e39000887bae0
Deploy Preview https://deploy-preview-762--mozilla-perfcompare.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.

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.33%. Comparing base (b3ed6d2) to head (b3ba2e0). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #762 +/- ## ======================================= Coverage 91.33% 91.33% ======================================= Files 87 87 Lines 2309 2309 Branches 433 433 ======================================= Hits 2109 2109 Misses 177 177 Partials 23 23 ``` | [Flag](https://app.codecov.io/gh/mozilla/perfcompare/pull/762/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla) | Coverage Ξ” | | |---|---|---| | [](https://app.codecov.io/gh/mozilla/perfcompare/pull/762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla) | `91.33% <ΓΈ> (ΓΈ)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

esanuandra commented 2 weeks ago

I'm not sure if displaying it in edit mode is right.

Carla-Moz commented 2 weeks ago

I'm not sure if displaying it in edit mode is right.

Our team has edit access; that's why you see it in edit mode. Everyone else sees it in viewer mode.