Skip to content

doc/starlight: Adjust theming to RIOT branding#21700

Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom
LasseRosenow:starlight-theming
Sep 5, 2025
Merged

doc/starlight: Adjust theming to RIOT branding#21700
crasbe merged 1 commit intoRIOT-OS:masterfrom
LasseRosenow:starlight-theming

Conversation

@LasseRosenow
Copy link
Copy Markdown
Member

@LasseRosenow LasseRosenow commented Sep 5, 2025 •
edited
Loading

Contribution description

I have adjusted the starlight theme to use the RIOT colors.
I used the starlight css variable generator:

So the colors don't exactly match the ones form the RIOT logo, which is because of accessibility.

I also changed the content heading fonts to use the RIOT brand "Miso" font

Old New
image image
image image

@github-actions github-actions bot added the Area: doc Area: Documentation label Sep 5, 2025
@AnnsAnns
Copy link
Copy Markdown
Member

AnnsAnns commented Sep 5, 2025

I am Ann and I approve this message 🐸👍

@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Sep 5, 2025
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

What's the license of the Miso font if we ship it? Is it redistributable?

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025

What's the license of the Miso font if we ship it? Is it redistributable?

Should be no problem, I stole it from the /doc/doxygen/src/fonts folder ;)

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

What's the license of the Miso font if we ship it? Is it redistributable?

Should be no problem, I stole it from the /doc/doxygen/src/fonts folder ;)

But couldn't you set the path to there instead of duplicating the files?

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025

The license is here: https://martennettelbladt.se/eula/

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025 •
edited
Loading

But couldn't you set the path to there instead of duplicating the files?

I thought this way is less confusing, since doxygen and starlight are distinct systems (it might be unexpected, that removing the font from the doxygen folder affects starlight), but I can change that if you prefer it.

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

But couldn't you set the path to there instead of duplicating the files?

I thought this way is less confusing, since doxygen and starlight are distinct systems (it might be unexpected, that removing the font from the doxygen folder affects starlight), but I can change that if you prefer it.

That would be awesome.

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025

Done :)

crasbe
crasbe reviewed Sep 5, 2025
View reviewed changes
@riot-ci
Copy link
Copy Markdown

riot-ci commented Sep 5, 2025 •
edited
Loading

Murdock results

✔️ PASSED

571fbf9 doc/starlight: Adjust theming to RIOT branding

Success Failures Total Runtime
1 0 1 02m:02s

Artifacts

crasbe
crasbe approved these changes Sep 5, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

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

You can squash the first two commits, that also fixes the check-commits error due to the loooong commiit message of the second commit.

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025 •
edited
Loading

Okay I it is squashed now and thank you for the review! :)

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

I think you can remove the leftovers from the commit description :D

image

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 5, 2025

I think you can remove the leftovers from the commit description :D

image

Oups I renamed it :)

@crasbe crasbe added this pull request to the merge queue Sep 5, 2025
Merged via the queue into RIOT-OS:master with commit 703feab Sep 5, 2025
25 checks passed
@LasseRosenow LasseRosenow deleted the starlight-theming branch September 5, 2025 18:18
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

Okay I it is squashed now and thank you for the review! :)

You're welcome. I'm glad that you are investing time and effort into the RIOT documentation.

@mcr
Copy link
Copy Markdown
Contributor

mcr commented Sep 6, 2025

So the colors don't exactly match the ones form the RIOT logo, which is because of accessibility.

Does this imply that the colour choices in the logo are not accessible?

@AnnsAnns
Copy link
Copy Markdown
Member

AnnsAnns commented Sep 6, 2025

So the colors don't exactly match the ones form the RIOT logo, which is because of accessibility.

Does this imply that the colour choices in the logo are not accessible?

It's fine for the logo, however, it didn't work as a background colour on a website since the contrast was way too stark

@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Sep 6, 2025

So the colors don't exactly match the ones form the RIOT logo, which is because of accessibility.

Does this imply that the colour choices in the logo are not accessible?

The logo doesn't contain text inside.
For the website the colors are used for text in combination with background which needs good contrast to be readable :)

@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crasbe crasbe crasbe approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

Release 2025.10

Development

Successfully merging this pull request may close these issues.

6 participants

@LasseRosenow @AnnsAnns @crasbe @riot-ci @mcr @benpicco