Boavizta / boaviztapi

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

Broken link (or missing page ?) in API documentation #335

Open demeringo opened 3 hours ago

demeringo commented 3 hours ago

Bug description

https://doc.api.boavizta.org/Explanations/components/usage/elec_conso.md returns 404

To Reproduce

Expected behavior

Verify if page exists under a different name and update (or remove) links

JSON OUTPUT

Additional context

demeringo commented 3 hours ago

Appears in several files:

❯ rg elec_conso.md
docs/docs/q&a.md
31:See: [Electricity methodology](Explanations/usage/elec_conso.md)

docs/docs/Explanations/components/ram.md
79:Both [power consumption](../usage/elec_conso.md) and [consumption profile](../consumption_profile.md) are implemented.

docs/docs/Explanations/usage/usage.md
5:Usage impacts are measured by multiplying a **[duration, a ratio of usage](duration.md)**, an **[impact factor](elec_factors.md)**, and an **[power](elec_conso.md)** :

docs/docs/Explanations/components/power_supply.md
62:Only [power consumption](../usage/elec_conso.md) is implemented.

docs/docs/Explanations/components/cpu.md
96:Both [power consumption](../usage/elec_conso.md) and [consumption profile](../consumption_profile.md) are implemented.

docs/docs/Explanations/components/motherboard.md
52:Only [power consumption](../usage/elec_conso.md) is implemented.

docs/docs/Explanations/components/ssd.md
82:Only [power consumption](../usage/elec_conso.md) is implemented.

docs/docs/Explanations/devices/iot_devices.md
61:Only [power consumption](../usage/elec_conso.md) is implemented.

docs/docs/Explanations/devices/server.md
107:Both [power consumption](../usage/elec_conso.md) and [consumption profile](../consumption_profile.md) are implemented.

docs/docs/Explanations/components/case.md
71:Only [power consumption](../usage/elec_conso.md) is implemented. In most cases, enclosure doesn't consume electricity.

docs/docs/Explanations/components/hdd.md
58:Only [power consumption](../usage/elec_conso.md) is implemented.
demeringo commented 3 hours ago

Maybe we could also introduce a link checker in the doc.

demeringo commented 3 hours ago

As an action: https://github.com/marketplace/actions/mkdocs-link-check

As a standalone exec (for writing the doc locally): https://pypi.org/project/mkdocs-linkcheck/