Skip to content

Conversation

@trueberryless
Copy link

@trueberryless trueberryless commented Aug 19, 2025

General Description

  • Create Starlight project under /website
  • Add useful plugins for these docs:
    • Changelogs: adds pages for last 7 releases automatically
    • Link checker: Automatically validate links
    • Kbd: Have nice keyboard inputs displayed (could be easily extended to Windows in the future)
    • Llms-txt: Automatically generates /llms.txt, /llms-small.txt and /llms-full.txt routes so AIs can work with the docs
    • Image Zoom: Adds zoom capabilities to all images because it is intuitive and makes sense.
    • GitHub Alerts: Since the current content is intended for GitHub and uses GitHub Alerts, we want to convert them automatically to Starlight asides.
    • Catppuccin theme: because it looks nice

Implementation Details

  • I separated the content from user-guides.md into multiple pages (per heading)
  • I made a dedicated folder for Sidebar because two of those sections seems to be more related to that instead of general "Guides" (could be nested into Guides folder...)
  • I moved all images from the "first places" to the bottom of each section cause it is much more user-friendly to have some text before the images load...
  • I recreated the index page in Markdown (should / could definitely improved). I took the current website as a reference, but now it doesn't look as nice. I might improve this but currently I'm not motivated to do that... (feel also free to ping me and say that you could do that if you want...)
  • Use AutoImport for the Kbd import because it is used in most files (f1db359)

Todos

  • Adapt Github deployment workflow OR setup Netlify (much easier AND offers PR Previews of the build...)
  • Adapt index.mdx page cause it now looks uglier
  • I think that even the docs which is not intended for the editor, but for the dev should be migrated to Starlight (there is an option to separate those topics with plugins)

Related PRs

@trueberryless
Copy link
Author

trueberryless commented Aug 19, 2025

UPDATE: Already mentioned in PR description

I did not change any building and deploying logic for now, do you maybe want to setup Netlify (which is free) which makes especially sense for OSS like this project?

Otherwise, it would be possible, but kinda tedious 😅 https://docs.astro.build/en/guides/deploy/github/

Docs
How to deploy your Astro site to the web using GitHub Pages.

@trueberryless trueberryless marked this pull request as ready for review August 19, 2025 15:50
@dannysmith
Copy link
Owner

Awesome, thanks @trueberryless 🙏

Will have a look at this tomorrow and make a decision on GH pages vs Netlify (vs Vercel, which I use for a bunch of other stuff) etc.

@dannysmith dannysmith self-requested a review August 19, 2025 16:52
@dannysmith
Copy link
Owner

Hey @trueberryless . The docs look great but I'm gonna do some work on the marketing page (ie index) before I merge this. Probably won't get to that for a week or two. Thanks for the work 🙂

@trueberryless
Copy link
Author

Totally valid, if I have time and maybe come back to this, I might write in here to update the index page myself, but it's unlikely as I also have much to do...

Take your time 🚀

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 marketing website to Astro/Starlight

2 participants