Skip to content

docs: Switch out pkg reference link#21229

Merged
mguetschow merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:docDeadLink
Feb 25, 2025
Merged

docs: Switch out pkg reference link#21229
mguetschow merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:docDeadLink

Conversation

@AnnsAnns
Copy link
Copy Markdown
Member

@AnnsAnns AnnsAnns commented Feb 19, 2025

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
Copy Markdown
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
Copy Markdown
Member Author

AnnsAnns commented Feb 21, 2025

I will adjust this, thank you for the feedback

@AnnsAnns
Copy link
Copy Markdown
Member Author

AnnsAnns commented Feb 23, 2025

Tested it locally, the reference worked correctly 👍

@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Feb 25, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Feb 25, 2025

Murdock results

✔️ PASSED

af986e2 docs: Switch out pkg reference link

Success Failures Total Runtime
1 0 1 01m:21s

Artifacts

mguetschow
mguetschow approved these changes Feb 25, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed works as expected: https://ci.riot-os.org/results/37447ca4712744988a74f3f02c2fa5d5/doc-preview/group__pkg.html

Thanks for fixing!

@mguetschow mguetschow added this pull request to the merge queue Feb 25, 2025
Merged via the queue into RIOT-OS:master with commit 41f6f23 Feb 25, 2025
27 checks passed
@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mguetschow mguetschow mguetschow approved these changes

Assignees

No one assigned

Labels

Area: doc Area: Documentation Area: pkg Area: External package ports CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Milestone

Release 2025.04

Development

Successfully merging this pull request may close these issues.

4 participants

@AnnsAnns @crasbe @riot-ci @mguetschow