-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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] Remove release candidate warnings #8109
Conversation
🦋 Changeset detectedLatest commit: 61df2eb The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@@ -4,7 +4,9 @@ title: Introduction | |||
|
|||
## Before we begin | |||
|
|||
> SvelteKit is in release candidate phase for 1.0 while we address reported issues and add polish. If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat). | |||
> If you're new to SvelteKit, do the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> If you're new to SvelteKit, do the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit). | |
> If you're new to SvelteKit, try the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why try
over do
? (might be my non-native-english me not understanding the subtle difference)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"do" reads slightly awkwardly to me. I'd probably make it something like "complete" if I wanted to make it a command. But it also feels slightly commanding to me whereas "try" is more of a recommendation than a command. It's pretty subtle and probably different people will have different views of it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 I'll adjust it
packages/create-svelte/bin.js
Outdated
@@ -180,7 +176,15 @@ async function main() { | |||
console.log(` ${i++}: ${bold(cyan('npm run dev -- --open'))}`); | |||
|
|||
console.log(`\nTo close the dev server, hit ${bold(cyan('Ctrl-C'))}`); | |||
console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}\n`); | |||
console.log( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems a bit verbose to include in the CLI. I'd probably just keep this portion how it was before
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that it's three items (a nice number of sentences), each is short, starts with a one-word-question, and serves a different purpose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the one I'm most hesitant about is encouraging people to file issues l. I sort of liked directing people to Discord first because then the community can help us triage a bit whether it's a usage issue or a bug that should be filed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, I'll remove that item.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like the tutorial to be a bit more buttoned up before we start directing people there without caveats. For example if you follow the link here you go to a page that begins
So far, we've been working on individual components, or groups of components, in isolation
which is a major WTF if you land there without context. Let's revert this to how it was before
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will push that change, one sec
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI I also mention the tutorial on the intro docs - do you want to remove it from there, too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think we can link to it, but with caveats (and probably to the first page, not straight to part 2). i'm going to tweak some other word in there anyway so will do that now
closes #8043
(marking as draft so we don't accidentally merge this early)
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpm changeset
and following the prompts. All changesets should bepatch
until SvelteKit 1.0