Broken link (or missing page ?) in API documentation

[demeringo]

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]

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]

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

[demeringo]

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/

[jonperron]

Hello !

I would like to contribute, and saw this issue as a good first issue. Is the scope limited to fix the doc, or should I create two PRs, one to add a link checker, then a second one to fix broken link issue ?

[demeringo]

Hi, thanks for proposing to help 👍

I think having 2 distinct PR will be easier.

• We can keep the current issue for fixing the documentation itself
• I just created a separate one Add a link checker when publishing documentation #359 to have a better tooling for checking the links (particularly in CI)

See also my draft PR where I started to work on the tooling. #336

[ju3ouz4n]

Hi @demeringo @jonperron , made a pull request on this issue. Sorry @jonperron, saw a little late the answer (already made the fix) you have the priority on this one.

[jonperron]

No problem @ju3ouz4n , I will work on the github actions, you have the fix