Skip to content

doc/doxygen: remove deprecated pages#21934

Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:remove_deprecated_pages
Dec 5, 2025
Merged

doc/doxygen: remove deprecated pages#21934
miri64 merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:remove_deprecated_pages

Conversation

@AnnsAnns
Copy link
Copy Markdown
Member

@AnnsAnns AnnsAnns commented Dec 5, 2025 •
edited
Loading

Contribution description

This removes all the deprecated pages from doxygen and makes it clear that the doxygen documentation is purely meant as API documentation, as decided in the coordination meeting.

This PR is blocked till the server side changes have been finished to redirect these pages automatically. (Thus I'm CCing @miri64)

Testing procedure

make doc and see a clean doxygen site.

Issues/PRs references

@github-actions github-actions bot added the Area: doc Area: Documentation label Dec 5, 2025
@AnnsAnns AnnsAnns requested a review from miri64 December 5, 2025 14:42
@AnnsAnns AnnsAnns added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Dec 5, 2025
AnnsAnns
AnnsAnns commented Dec 5, 2025
View reviewed changes
doc/doxygen/src/mainpage.md
Comment on lines -50 to -52

Getting Started
==================
Copy link
Copy Markdown
Member Author

@AnnsAnns AnnsAnns Dec 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

RE: The removal of this section, this is already part of the guide page, I just left it there because I felt like it before: https://guide.riot-os.org/general/structure/

Now that we fully committed to the guide site, this would only cause desync over time between both versions

@github-actions github-actions bot added Area: drivers Area: Device drivers Area: arduino API Area: Arduino wrapper API Area: sys Area: System labels Dec 5, 2025
@AnnsAnns AnnsAnns force-pushed the remove_deprecated_pages branch from 243c707 to bbe2be3 Compare December 5, 2025 14:50
miri64
miri64 requested changes Dec 5, 2025
View reviewed changes
doc/doxygen/src/mainpage.md Outdated

[TOC]

Doxygen API Documentation
Copy link
Copy Markdown
Member

@miri64 miri64 Dec 5, 2025

Choose a reason for hiding this comment

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

Suggested change
Doxygen API Documentation
RIOT-OS API Documentation

Otherwise, one might be tempted to think this is the API doc of Doxygen ;-) (+ end-users rarely care which tool was used to generate the doc)

@AnnsAnns AnnsAnns force-pushed the remove_deprecated_pages branch from bbe2be3 to 88f6c1c Compare December 5, 2025 15:21
miri64
miri64 reviewed Dec 5, 2025
View reviewed changes
doc/doxygen/src/mainpage.md Outdated
Comment on lines 15 to 56
@@ -47,191 +56,3 @@ RIOT is developed by an open community that anyone is welcome to join:
[riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org)
Copy link
Copy Markdown
Member

@miri64 miri64 Dec 5, 2025

Choose a reason for hiding this comment

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

RIOT in a nutshell also exists at this URL https://guide.riot-os.org/. So why keep this?

@AnnsAnns AnnsAnns force-pushed the remove_deprecated_pages branch from 88f6c1c to e2927ed Compare December 5, 2025 15:23
miri64
miri64 approved these changes Dec 5, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@miri64 miri64 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

ACK. Looking fine when built locally :-)

@miri64 miri64 enabled auto-merge December 5, 2025 15:26
@AnnsAnns
Copy link
Copy Markdown
Member Author

AnnsAnns commented Dec 5, 2025

yipee thank you

@riot-ci
Copy link
Copy Markdown

riot-ci commented Dec 5, 2025

Murdock results

✔️ PASSED

e2927ed doc/doxygen: remove deprecated pages

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

Artifacts

@miri64 miri64 added this pull request to the merge queue Dec 5, 2025
Merged via the queue into RIOT-OS:master with commit 55564ab Dec 5, 2025
26 checks passed
@leandrolanzieri leandrolanzieri added this to the Release 2026.01 milestone Jan 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@miri64 miri64 miri64 approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

Labels

Area: arduino API Area: Arduino wrapper API Area: doc Area: Documentation Area: drivers Area: Device drivers Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs

Projects

None yet

Milestone

Release 2026.01

Development

Successfully merging this pull request may close these issues.

4 participants

@AnnsAnns @riot-ci @miri64 @leandrolanzieri