search

thegreenwebfoundation / developer-docs

The developer documentation site for The Green Web Foundations open source libraries.
https://developers.thegreenwebfoundation.org
Apache License 2.0
5 stars 12 forks source link

Extend documentation #29

Closed drydenwilliams closed 10 months ago

drydenwilliams commented 11 months ago

Is your feature request related to a problem? Please describe. There are lots of method names in the models that I find confusing. e.g perByteTrace and perVisitTrace within the customise-website-carbon-calculations pages.

Describe the solution you'd like With each method, it should have a description e.g.

perByteTrace

This means that it....

perVisitTrace

This means that it....

fershad commented 11 months ago

Yep good point, it's worth having a small explainer (or link to an explainer) about each function.

fershad commented 11 months ago

Since this issue is related to the docs website, I've moved it into that repo (out of the CO2.js repo)

fershad commented 10 months ago

Added docs for both functions to the https://developers.thegreenwebfoundation.org/co2js/methods/ page.