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

First step of tutorial leads to confusion for new users #1173

Open
cazeth opened this issue Feb 28, 2025 · 1 comment
Open

First step of tutorial leads to confusion for new users #1173

cazeth opened this issue Feb 28, 2025 · 1 comment

Comments

@cazeth
Copy link

cazeth commented Feb 28, 2025

I am reading the basic svelte tutorial and trying to follow it locally. The first page of the tutorial claims that you can follow along locally by running npx sv create.

The problem is that when the user does this he or she is presented with a few template options (SvelteKit minimal, SvelteKit demo, Svelte Library) where it is not explicitly mentioned to the user which alternative to choose. My guess is that most users would choose Svelte Library since the tutorial is for Svelte whereas SvelteKit comes later in the tutorial. After doing this, however, the user is stuck in a structure that does not resemble the folder structure in the tutorial. The provided template creates a structure with src/routes/+page.svelte and it is unclear where and how to unite this with the structure in the tutorial without some guessing and restructuring, which might feel overwhelming and lacking to a new user who just want to get started and test some stuff out.

So the issue is that this first step is lacking and needs some work with hand-holding for users who are running the tutorial locally so that they get explicit instructions on what to do to get started and don't feel immediately lost and confused and need to problem-solve, which I guess is what you never want for a tutorial like this.

@sacrosanctic
Copy link

The first page of the tutorial claims that you can follow along locally by running npx sv create.

I think this is a misinterpretation. The text says

You can also consult the API docs and visit the playground, or — if you’re impatient to start hacking on your machine locally — create a project with npx sv create.

Which reads more like, "if the pacing is too slow, you can take off the handrails (aka the tutorial) and just start using Svelte". It does not say follow along locally.

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

No branches or pull requests

2 participants