doc/starlight: add route middleware to fix edit link #21780
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
AnnsAnns
added
Type: bug
crasbe
reviewed
Oct 10, 2025
doc/starlight/src/routeData.ts
Outdated
Comment on lines
11
to
12
| * As soon as base directory changes get fixed, this should be removed | ||
| * again! |
Contributor
There was a problem hiding this comment.
Is there an open issue in Starlight for that so the status can be tracked?
Member
There was a problem hiding this comment.
Not an issue, but at least a PR
Member
Author
|
🎾 squash |
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
Since we currently use a symlink (as introduced in bcd9fbe to comply with the (broken) docs folder scanning of starlight, this will break the edit link since, while technically correct, our symlink will be shown as github.com/RIOT-OS/RIOT/doc/guides/src/content/docs/foobar.md.
Since github can't parse symlinks, we need to modify the editUrl through a route middleware in order for the edit link to still function.
As soon as base directory changes get fixed, this should be removed again!
(Ty to @LasseRosenow for noticing that)
Testing procedure
Issues/PRs references