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

docs: Switch out pkg reference link #21229

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AnnsAnns
Copy link
Contributor

Contribution description

Currently the pkg documentation @ https://doc.riot-os.org/group__pkg.html has a link that is supposed to point to https://doc.riot-os.org/creating-modules.html#modules-outside-of-riotbase but on the Doxygen Output it simply creates a dead (and confusing) link to https://doc.riot-os.org/src/creating-modules.html#modules-outside-of-riotbase.

Simply replacing it with the full link should cover both people using the doxygen documentation and people checking out the doc.txt itself.

Testing procedure

Issues/PRs references

@github-actions github-actions bot added Area: doc Area: Documentation Area: pkg Area: External package ports labels Feb 19, 2025
@crasbe
Copy link
Contributor

crasbe commented Feb 19, 2025

The section modules-outside-of-riotbase actually has a label, so you can access it with the @ref command.

[external modules](@ref modules-outside-of-riotbase) creates a link to html/creating-modules.html#modules-outside-of-riotbase. Your solution would not work on a local machine. The full link for me locally is file://wsl.localhost/Ubuntu-22.04/home/cbuec/riot-xipfs/RIOT/doc/doxygen/html/creating-modules.html#modules-outside-of-riotbase.

With the @ref command, it works either way.

@AnnsAnns
Copy link
Contributor Author

I will adjust this, thank you for the feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Area: pkg Area: External package ports
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants