codacy / codacy-coverage-reporter

Multi-language coverage reporter for Codacy
https://www.codacy.com
Other
134 stars 94 forks source link

doc: Add troubleshooting for coverage error statuses CY-6365 #409

Closed prcr closed 2 years ago

prcr commented 2 years ago

Adds troubleshooting instructions for the possible coverage "error status" displayed on the coverage set-up page for each repository:

Also moves the guidance for scenarios where the coverage value isn't displayed on the Codacy UI directly to the main section "Validating coverage" so that users don't need to navigate away from the main sequence of instructions.

:eyes: Live preview

https://feat-update-codacy-coverage-reporte--docs-codacy.netlify.app/coverage-reporter/#validating-coverage

:construction: To do

prcr commented 2 years ago

@prcr Overall, consider giving more place between sections for readability purposes, the page looks quite condense. bow

I experimented with including all scenarios/error statuses in the same table, and I think this improves the readability of the troubleshooting section.