Add docs for Greencheck API

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 13 forks source link

Add docs for Greencheck API #17

Closed fershad closed 1 year ago

fershad commented 1 year ago

This PR introduces API documentation pages to the website. This will include new sections on the homepage, as well as in the menu.

The first API documented will be v2 and v3 of the Greencheck API.

cloudflare-workers-and-pages[bot] commented 1 year ago

Deploying with Cloudflare Pages

Latest commit:	`07d4624`
Status:	✅ Deploy successful!
Preview URL:	https://bfbc72bf.developer-docs-64x.pages.dev
Branch Preview URL:	https://add-api-docs.developer-docs-64x.pages.dev

View logs

fershad commented 1 year ago

After discussion today, it was decided that a change of priority for API documentation was appropriate. This PR will now:

Introduce API documentation entry points to the website (homepage & nav)
Document v3 of the Greencheck API for checking a single domain
Document the IP to CO2 Intensity API

Version 2 of the Greencheck API will not be documented, since we would like to move developers towards using v3. Functionality is identical to v3, and so if we need to document this later we can do so easily.

Greencheck batch URL checking will be documented at a later date.

fershad commented 1 year ago

This one's ready for review.

fershad commented 1 year ago

@tortila I've made a the changes you suggested. Could you please double check to make sure that everything we need is there. If all good, I'll merge this branch on Thursday.