Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
demeringo opened this issue Nov 18, 2024 · 3 comments
Open

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

demeringo opened this issue Nov 18, 2024 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@demeringo
Copy link
Collaborator

demeringo commented Nov 18, 2024

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 demeringo added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 18, 2024
@demeringo
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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

@demeringo
Copy link
Collaborator Author

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant