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

Tiny suggestion: REPL introduction instead of basic Hello World #708

Open
kuhlaid opened this issue May 21, 2020 · 9 comments
Open

Tiny suggestion: REPL introduction instead of basic Hello World #708

kuhlaid opened this issue May 21, 2020 · 9 comments

Comments

@kuhlaid
Copy link

kuhlaid commented May 21, 2020

I get the feeling some users (including myself) do not realize that the Svelte REPL can be saved and forked by visitors of the REPL if their first introduction is simply the default hello world app. I'm wondering if something like https://svelte.dev/repl/2c06d586d890466e8dc7da6fb111efb7 would be a better intro to the REPL? Once you are familiar with the UI of the REPL it is easy to work with, but I suspect a good amount is overlooked initially by first timers.

@ConProgramming
Copy link

I agree, when I first used the REPL I didn't realize how much it could do

@antony
Copy link
Member

antony commented May 22, 2020

I don't really like this as it is a lot to delete when you just want to use the REPL, as I often do.

If there were a less wordy way to express the same information, it might be more useful.

I definitely wouldn't want there to be multiple files.

@kuhlaid
Copy link
Author

kuhlaid commented May 22, 2020

Good point @antony. An alternative would be to keep the Hello World simple, but provide a link to instructions like this:
https://svelte.dev/repl/d217fb89cb0d40d9b81163bb68149076?version=3.22.3

@mjgartendev
Copy link

This seems like a reasonable use for the markdown support implemented recently:

image

I think the intent was to document component examples, so including a single md file as part of the base REPL template doesn't seem too intrusive?

Although I think the gist import removes the README.md file if it exists so I'm not sure how much work this would take.

@tbmreza
Copy link

tbmreza commented May 25, 2020

@mjgartendev
Clarification: With README tab greets the user upon landing to https://svelte.dev/repl/?

@mattwolff
Copy link

It could be helpful to give users (especially new ones) more details about using the REPL.
However, I really appreciate how straightforward the code editor itself is. I wouldn't want any additional files or extra details to delete from within the REPL itself.

Instead, I wonder if some version of an Intro text for the REPL elaborating on the UI and its options might be better suited elsewhere on the site: as a longer blog post, part of the FAQs, or even adding something like an Info button to the App Controls.

@opensas
Copy link

opensas commented Jun 9, 2020

Good point @antony. An alternative would be to keep the Hello World simple, but provide a link to instructions like this:
https://svelte.dev/repl/d217fb89cb0d40d9b81163bb68149076?version=3.22.3

Agree on this one, I think this is the best option. And I also agree that the repl is quite often an underestimated tool, so a message like this could be very helpful.

@stale
Copy link

stale bot commented Dec 24, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@opensas
Copy link

opensas commented Dec 24, 2021

Anther posibility could be to show a welcome tour with a check stating do not show again, that would give us the best of both worlds
With the same logic, we could show a readme with new features (similar to what vscode does), I didn't even know that md files were supported, for example

@dummdidumm dummdidumm transferred this issue from sveltejs/svelte Oct 29, 2024
@linear linear bot added the svelte.dev label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants