Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API
GNU Affero General Public License v3.0
66 stars 23 forks source link

Add a FAQ section to the doc #127

Closed demeringo closed 1 year ago

demeringo commented 1 year ago

Problem

We could use a FAQ section to address some questions that come back often.

Solution

Use this issue to gather some inital content and then report it to the API doc.

Some idea:

Alternatives

Additional context or elements

API doc is quite detailed but more oriented towards technical or users already familiar with the subject, a FAQ could provide simple answer and point to other sections for details.

da-ekchajzer commented 1 year ago

I have initialized an FAQ. See commit : d115425. Do you find it sufficient for the v0.2 ? If so you can close the issue. If not please share your feedback !

demeringo commented 1 year ago

Hi @da-ekchajzer, did not have time to review it yet, but will do ;-)

Another idea was to explain carbon intensity factor we use to assess COeq emission from power. (i.e. where this carbon intensity factor originates from, granularity in term of country/location and at which rate it is refreshed in the boavizta API). Forget about it, I realize you mentioned it in the chapter about GWP factor https://github.com/Boavizta/boaviztapi/blob/main/docs/docs/Explanations/usage.md#gwp---global-warming-potential-factor