Skip to content

Conversation

@richardscull
Copy link
Member

@richardscull richardscull commented Jan 24, 2026

Overview

This PR migrates all documentation from Docusaurus to Starlight

The primary reason was described in #3, where we bumped into the build related projects (too high memory consumption, long build time, etc.). I find any such issues to be very unexpected for the simple documentation website.

All the related issues seems to be fixed related with move to Starlight.

Some stats:

gantt
    title Build Time Comparison
    dateFormat  s
    axisFormat  %S s

    section Build
    Starlight (26s) :starlight, 0, 26
    Docusaurus (57s) :docusaurus, 0, 57
Loading
gantt
    title Peak Memory Usage (GiB-equivalent scale)
    dateFormat X

    section Memory
    Starlight (0.7 GiB) :starlight, 0, 700
    Docusaurus (3 GiB)  :docusaurus, 0, 3000

Loading

So generally the starlight fixes our problems with builds.

Related changes due to the migration

Regressions

  • We dropped plugin to support tailwindcss
    • Starlight does have plugins to support tailwindcss, but this decision is actually come from my side. I think it's too much overhead from a simple task it was doing before.

Changes

  • We updated the website theme a little
  • Added Github workflow to test the build }
  • Different font
  • Added image optimisation

Everything else is backwards compatible.



Closes #4

@richardscull richardscull marked this pull request as ready for review January 24, 2026 21:23
@richardscull richardscull merged commit 49ae1e2 into main Jan 24, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate to Starlight

2 participants