How do you actually create a project using the AstroWind template?

[shirakaba]

I'm going to be honest, this project has the worst onboarding docs I have ever seen. Here's the journey a user goes through trying to figure out how to install this thing.

Docs site

Above the fold

The "Get template" button sends you to this GitHub repo.

Below the fold

The landing page is several A4 pages in length with no setup instructions.

The FAQ

The FAQ appears to be AI-generated placeholder text or something as it doesn't explain a single thing.

Call to action

Again, this sends you to the GitHub repo.

The docs

Clicking "Docs" at the bottom just routes you back to the landing page.

GitHub repo

Alright, so let's look through the repo.

The GitHub sidebar links you back to the docs site.

The listed commands are all for once you've already set up the template:

The FAQ is just an incomplete bullet-point list saying "why?"

Astro themes

The official themes marketplace just sends you back here:

The parent page doesn't give any more guidance as to how to install it.

And searching for themes on the Astro docs brings up only unrelated results:

Vercel templates

The Vercel templates are probably the only thing that give you some sort of actionable to get set up, but why not a CLI command; why should I have to perform SSO to perform a git clone?

---

So, how do you actually adopt AstroWind? Could it be documented on the README and the hosted site?

[shirakaba]

For anyone who lands here, you can work it out from the Astro installation docs:

npm create astro@latest -- --template onwidget/astrowind

Bear in mind that searching for "theme" on the Astro docs does not find this page! Only searching for "template" brings it up.

The best solution for onboarding would be to show this command in both the repo README and on the demo site.

[prototypa]

Hi @shirakaba

Inspired by your comment we have added this to the READMEL https://github.com/onwidget/astrowind?tab=readme-ov-file#tldr

[shirakaba]

Sorry for the negativity in the original post, was just frustrated at the time. Thank you for the action! 😍

[porobertdev]

I found a hidden doc on astrowind's blog that's not lorem-ipsum: https://astrowind.vercel.app/astrowind-template-in-depth

It's far from complete, but better than nothing. The project is great, but the lack of documentation kinda keeps me away from it. I still can't easily understand how it's structured and how it works, so that I can extend with variants and other components.