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

Docs: set CLI as the new SvelteKit onboarding default #628

Closed
endigo9740 opened this issue Dec 2, 2022 · 1 comment · Fixed by #661
Closed

Docs: set CLI as the new SvelteKit onboarding default #628

endigo9740 opened this issue Dec 2, 2022 · 1 comment · Fixed by #661
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@endigo9740
Copy link
Contributor

Link to the Page

https://www.skeleton.dev/guides/install

Describe the Issue

Let's update and tailor the onboarding documentation to recommend the CLI by default. We'll want to clearly indicate it's in beta, however, we've had zero issues reported since it went live. It seems to be doing everything we need it to do.

The challenge here will be balancing the onboarding user path. Essentially there's two options now:

  1. SvelteKit users that use the CLI - they can skip straight to building their apps
  2. SvelteKit/Vite/Astros that either bypass or can't use the CLI - they still need the written instruction

Additionally, some of the information in the written guide is beneficial to CLI users - such as how to set or create a custom theme, how to override styles and use component props, and just generally know what the CLI is doing for them.

Are you able to create a Pull Request with the fix?

Yes

@endigo9740 endigo9740 added the documentation Improvements or additions to documentation label Dec 2, 2022
@endigo9740 endigo9740 self-assigned this Dec 2, 2022
@endigo9740 endigo9740 pinned this issue Dec 2, 2022
@endigo9740
Copy link
Contributor Author

endigo9740 commented Dec 2, 2022

NOTE: we'll want to implement a quick tab switcher for the CLI and support to deep link to the Vite/Astro tabs:

https://www.skeleton.dev/guides/install?framework=sveltekit|vite|astro

@endigo9740 endigo9740 added this to the v1.0 milestone Dec 4, 2022
@endigo9740 endigo9740 linked a pull request Dec 8, 2022 that will close this issue
@endigo9740 endigo9740 unpinned this issue Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant