doc: use https://api.riot-os.org for API doc #21968
Merged
Conversation
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
The documentation at https://guide.riot-os.org has become the defacto entry point for RIOT documentation. We may dedice to let https://doc.riot-os.org point to that doc, rather than to the API doc. In order to keep the links in the repo working when we pull through, this updates all doc to the API doc to `https://api.riot-os.org`. This already works today and will keep working even if `https://doc.riot-os.org` stops pointing to the API doc.
maribu
requested review from
AnnsAnns,
aabadie,
jia200x and
miri64
as code owners
github-actions
bot
added
Area: doc
mcr
approved these changes
Dec 23, 2025
maribu
added
the
CI: ready for build
Murdock results✔️ PASSED e62f2d4 doc: use https://api.riot-os.org for API doc
Artifacts |
Member
Author
|
Thx ❤️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
The documentation at https://guide.riot-os.org has become the defacto entry point for RIOT documentation. We may dedice to let https://doc.riot-os.org point to that doc, rather than to the API doc.
In order to keep the links in the repo working when we pull through, this updates all doc to the API doc to
https://api.riot-os.org. This already works today and will keep working even ifhttps://doc.riot-os.orgstops pointing to the API doc.Testing procedure
All links should still work and show the same page as before, just at
api.riot-os.orginstead ofdoc.riot-os.org.Issues/PRs references
None