doc/doxygen: remove deprecated pages#21934
Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom Dec 5, 2025
Merged
Conversation
AnnsAnns
commented
Dec 5, 2025
Comment on lines
-50
to
-52
|
|
||
| Getting Started | ||
| ================== |
Member
Author
There was a problem hiding this comment.
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
243c707 to
bbe2be3
Compare
miri64
requested changes
Dec 5, 2025
doc/doxygen/src/mainpage.md
Outdated
|
|
||
| [TOC] | ||
|
|
||
| Doxygen API Documentation |
Member
There was a problem hiding this comment.
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)
bbe2be3 to
88f6c1c
Compare
miri64
reviewed
Dec 5, 2025
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) | |||
Member
There was a problem hiding this comment.
RIOT in a nutshell also exists at this URL https://guide.riot-os.org/. So why keep this?
88f6c1c to
e2927ed
Compare
miri64
approved these changes
Dec 5, 2025
Member
Author
|
yipee thank you |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 docand see a clean doxygen site.Issues/PRs references