doc/starlight: Add temporary workaround to symlink issue #21787
Conversation
AnnsAnns
added
Type: bug
| dev: install | ||
| @echo "Linking RIOT documentation source files..." | ||
| @rm -rf $(CURDIR)/src/content/docs | ||
| @ln -s ../../../guides $(CURDIR)/src/content/docs |
There was a problem hiding this comment.
Why not copy as well? If I see it correct, this means that dev would still have broken :::note blocks right?
There was a problem hiding this comment.
The big disadvantage would be no hot-reloading, I'd rather have no note blocks than starlight function like doxygen
There was a problem hiding this comment.
We can add a dev-build-preview that uses npm run preview on the deployment version that was generated using make build
There was a problem hiding this comment.
Fair I think a make preview command is enough
There was a problem hiding this comment.
Added a make preview command
LasseRosenow
left a comment
LasseRosenow
left a comment
There was a problem hiding this comment.
Not sure about still using the symlink in dev
|
The starlight maintainers (already) responded back. It looks like this (and all the other issue we have related to it) will possibly be fixed in the next minor release so if everything goes well this commit will be fairly short-lived :) |
4 participants
Contribution description
@LasseRosenow noticed that due to the switch to a symlink instead of setting the baseDirectory (as base directory changes are currently broken on starlight (See: 261600a, #21769 and withastro/starlight#3332)) MDX notes (and presumably other syntax?) are utterly broken.
To circumvent this for now, we do a full copy of the guides folder on deploy builds, this appears to "fix" the issue for now.
See: withastro/starlight#3470 for a bug report about this.
Testing procedure
Issues/PRs references