Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial seems out of sync with latest #10843

Open
flcdrg opened this issue Jan 30, 2025 · 6 comments
Open

Tutorial seems out of sync with latest #10843

flcdrg opened this issue Jan 30, 2025 · 6 comments
Labels
bug Something on the site isn't working

Comments

@flcdrg
Copy link

flcdrg commented Jan 30, 2025

📝 Issue Description

The tutorial instructions seem outdated or are incomplete.

The page says to run npm create astro@latest -- --template minimal, and then press 'y' to create the template.

But the output of this command presents a menu, and I'm confused.

Image

On the one hand there is a default to select, but the tutorial is titled 'Build a blog' so should I be picking the blog template? I don't want to make the wrong choice as possibly this will mean I go down the wrong path with the tutorial!

Additionally, the tutorial says "When the prompt asks you where to create the project"

But I never get asked where to create the project - it seems to use 'minimal' as the directory name

📋 On which page(s) it occurs

https://docs.astro.build/en/tutorial/1-setup/2/

🤔 Expected Behavior

Instructions match what the tooling provides

👀 Current Behavior

Choices that aren't mentioned in the tutorial

🖥️ Browser

Firefox

📄 Additional Information

No response

@flcdrg flcdrg added the bug Something on the site isn't working label Jan 30, 2025
@delucis
Copy link
Member

delucis commented Jan 30, 2025

Hi @flcdrg! Could you share what OS and Terminal app you’re using? I just double checked the command and saw the expected behaviour:

terminal output showing create astro being run with a template flag and that template being used correctly

But I vaguely remember someone reporting something similar in the past for certain platforms related to the -- separator npm requires. I can’t remember now but it may have been some platforms needed a --- separator with three hyphens instead of two?

@flcdrg
Copy link
Author

flcdrg commented Jan 30, 2025

Windows 11, Windows Terminal (running PowerShell)

@flcdrg
Copy link
Author

flcdrg commented Jan 30, 2025

Note that the confusion continued on https://docs.astro.build/en/tutorial/1-setup/3/ where it shows the index.astro page content. But the minimal content page that I get is completely different:

Image

@flcdrg
Copy link
Author

flcdrg commented Jan 31, 2025

FYI I figured out that this seems to be PowerShell related. If I escape the double dash, then it appears to install the minimal template and prompt for the directory. eg.

npm create astro@latest `-- --template minimal

@flcdrg
Copy link
Author

flcdrg commented Jan 31, 2025

oh.. and now it looks like the index.astro content is as per the tutorial!

So I assume "--template minimal" is generating different content to if you use "A basic, minimal starter" from the prompt.

@delucis
Copy link
Member

delucis commented Jan 31, 2025

So I assume "--template minimal" is generating different content to if you use "A basic, minimal starter" from the prompt.

Correct — the “basics” one in the prompt is a notch up from “minimal” 😁

this seems to be PowerShell related

Ahhh, that’s what I wondered. That’s quite annoying that different terminals need escaping in these different ways. Makes it very hard for us to document commands consistently. Not sure what would be best for us to do 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something on the site isn't working
Projects
None yet
Development

No branches or pull requests

2 participants