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

Add documentation for Sustainable Web Design Model version 4 in CO2.js #51

Closed fershad closed 1 week ago

fershad commented 1 month ago

Is your feature request related to a problem? Please describe. No.

Describe the solution you'd like An updated version of the Sustainable Web Design Model is being added to CO2.js in the next release (v0.16). This model will initially be available for developers to opt in to using, with the current version (version 3) remaining the default model used in CO2.js for the time being.

Updates to the documentation are required to show developers how to opt in to using the Version 4 methodology. There are no functionality changes from version 3 to version 4, however the results returned by the segment and perByteTrace and perVisitTrace functions do change to reflect the operation/embodied emissions breakdown in the newer version. This should also be shown to developers.

Additional context Related PR merging SWDM v4 into CO2.js can be found at: https://github.com/thegreenwebfoundation/co2.js/pull/208