Skip to content

doc/starlight: Add temporary workaround to symlink issue #21787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

doc/starlight: Add temporary workaround to symlink issue #21787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b9af38
doc/starlight: Add temporary workaround to symlink issue
AnnsAnns Oct 13, 2025
306f614
doc/starlight: add preview command
AnnsAnns Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/starlight/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store

# Don't show copied files
src/content/docs/**
11 changes: 11 additions & 0 deletions doc/starlight/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,22 @@ install: integrate_outside_files

.PHONY: build
build: install
@echo "Copying RIOT documentation source files..."
@echo "See: https://github.com/withastro/starlight/issues/3470"
@rm -rf $(CURDIR)/src/content/docs
@cp -r $(RIOTBASE)/doc/guides $(CURDIR)/src/content/docs
@npm run build --prefix $(CURDIR)
@echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/starlight/dist/index.html"

.PHONY: preview
preview: build
@npm run preview --prefix $(CURDIR)

.PHONY: dev
dev: install
@echo "Linking RIOT documentation source files..."
@rm -rf $(CURDIR)/src/content/docs
@ln -s ../../../guides $(CURDIR)/src/content/docs
Copy link
Member

@LasseRosenow LasseRosenow Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not copy as well? If I see it correct, this means that dev would still have broken :::note blocks right?

Copy link
Member Author

@AnnsAnns AnnsAnns Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The big disadvantage would be no hot-reloading, I'd rather have no note blocks than starlight function like doxygen

Copy link
Member Author

@AnnsAnns AnnsAnns Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add a dev-build-preview that uses npm run preview on the deployment version that was generated using make build

Copy link
Member

@LasseRosenow LasseRosenow Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair I think a make preview command is enough

Copy link
Member Author

@AnnsAnns AnnsAnns Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a make preview command

@echo "Starting starlight live server..."
@npm run dev --prefix $(CURDIR)

Expand Down
1 change: 0 additions & 1 deletion doc/starlight/src/content/docs
View file
Open in desktop

This file was deleted.