Skip to content

doc/starlight: split sidebar into categories#22481

Open
AnnsAnns wants to merge 2 commits into
RIOT-OS:masterfrom
AnnsAnns:clean_starlight
Open

doc/starlight: split sidebar into categories#22481
AnnsAnns wants to merge 2 commits into
RIOT-OS:masterfrom
AnnsAnns:clean_starlight

Conversation

@AnnsAnns

Copy link
Copy Markdown
Member

Contribution description

While its a neat problem to have, the starlight documentation has become way too big for a singular sidebar, esp. with the upcoming #21582 and #22460. Thus I decided to split it into three categories for now using the plugin by HiDeo (we already use one plugin by him and he is also a core maintainer of starlight [Was always really helpful when we had issues too 😄]).

I decided not to move the slugs around for now (except for the networking category required for the other PRs), every time we change the slug we need to add a redirect for it which felt a bit annoying.

Before

image

After

image image image

Testing procedure

make doc-starlight

Issues/PRs references

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

  • A really loud room of people

@AnnsAnns
AnnsAnns requested review from aabadie and jia200x as code owners July 18, 2026 12:43
@github-actions github-actions Bot added the Area: doc Area: Documentation label Jul 18, 2026
@AnnsAnns AnnsAnns added 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 AI: Not Used AI was stated to not be used in this PR/Issue labels Jul 18, 2026
@riot-ci

riot-ci commented Jul 18, 2026

Copy link
Copy Markdown

Murdock results

✔️ PASSED

59792d9 doc/starlight: update all dependencies

Success Failures Total Runtime
1 0 1 01m:13s

Artifacts

@crasbe crasbe added the Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation label Jul 18, 2026
@crasbe

crasbe commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Can we creep a package.lock update commit in to make @dependabot happy (for a while)?

@AnnsAnns

Copy link
Copy Markdown
Member Author

Can we creep a package.lock update commit in to make @dependabot happy (for a while)?

oki

@AnnsAnns

Copy link
Copy Markdown
Member Author

Done, was able to update everything to the very latest version (Should have received some nice Typescript and Astro speedups)

@LasseRosenow

Copy link
Copy Markdown
Member

Since you updated astro and starlight I figure it is now using the satteri markdown parser, which means it is likely that the image zoom is not working anymore eand GitHub emojis potentially also not. Have you verified? I cannot test it I am on the train.

If something is broken you can set the markdown parser to "unified", which should restore compatibility. In this case please add a comment to remove this once the plugins work.

@LasseRosenow

Copy link
Copy Markdown
Member

Regarding the sidebar split, I personally find this ui concept confusing, (but maybe this is just me xD)

@AnnsAnns

Copy link
Copy Markdown
Member Author

Since you updated astro and starlight I figure it is now using the satteri markdown parser, which means it is likely that the image zoom is not working anymore eand GitHub emojis potentially also not. Have you verified? I cannot test it I am on the train.

If something is broken you can set the markdown parser to "unified", which should restore compatibility. In this case please add a comment to remove this once the plugins work.

We (starlight itself?) still use the old one, it gives us a deprecation warning for now

@AnnsAnns

AnnsAnns commented Jul 20, 2026

Copy link
Copy Markdown
Member Author

Regarding the sidebar split, I personally find this ui concept confusing, (but maybe this is just me xD)

The alternative is to have a lot of collapsed sidebars or a very lengthy sidebar, both feel clunky. I'm open to other alternatives,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI: Not Used AI was stated to not be used in this PR/Issue 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: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants