doc/starlight: fix edit link for generated documents #21987
Conversation
|
|
||
| if (starlightRoute.editUrl) { | ||
| let editUrl = starlightRoute.editUrl.toString(); | ||
|
|
There was a problem hiding this comment.
(somehow, Github renders this suggestion weirdly. I mean: remove trailing whitespaces, please, i.e., keep the line empty)
| const filename = editUrl.split(generatedPath)[1]; | ||
| editUrl = editUrl.split(generatedPath)[0] + '/' + filename; | ||
| } | ||
|
|
miri64
added
the
CI: ready for build
| const filename = editUrl.split(generatedPath)[1]; | ||
| editUrl = editUrl.split(generatedPath)[0] + '/' + filename; |
There was a problem hiding this comment.
As far as I understand this (very weird; why not just use '/' as a token and use the first and last element of the string) parsing step, this basically assumes that all files were generated from root. This invites potential footguns IMHO and also might lead to maybe unrelated files (something about boards/ e.g.) hogging the already quite crowded root path. I'd rather have a mapping somewhere, where the name of the generated file is mapped to the original source. It can be in this file, but maybe it makes sense to hook this directly into the generation somehow. This way, we would avoid risks of the generation and the edit links going potentially out of sync.
3 participants
Contribution description
@miri64 noticed that the edit link was broken when the site was generated using one of the root markdown files, this should fix that.
Testing procedure
make doc-starlightand then click on the edit page link on e.g. SecurityIssues/PRs references