Skip to content

Commit f1e4fd7

Browse files
authored
[docs] Remove release candidate warnings (sveltejs#8109)
closes sveltejs#8043
1 parent 3bf6290 commit f1e4fd7

File tree

5 files changed

+23
-54
lines changed

5 files changed

+23
-54
lines changed

.changeset/rude-pears-hammer.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'create-svelte': patch
3+
---
4+
5+
[feat] remove release candidate banner

README.md

+13-40
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,31 @@
11
[![Chat](https://img.shields.io/discord/457912077277855764?label=chat&logo=discord)](https://svelte.dev/chat)
22

3-
# READ THIS FIRST!
3+
# SvelteKit
44

5-
SvelteKit is in its release candidate phase:
6-
- :exclamation: expect bugs!
7-
- :heavy_check_mark: no more planned breaking changes
8-
- :heavy_check_mark: countdown to a stable release
9-
- :x: feature-complete
10-
- :x: tutorials
11-
12-
Watch [the announcement](https://www.youtube.com/watch?v=A8jkJTWacow&t=29628s) and track [progress towards 1.0](https://github.com/sveltejs/kit/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.0) for more details.
13-
14-
## Overview
15-
16-
The Fastest Way to Build Svelte Apps
17-
18-
- 💨 Blazing-Fast Production Sites
19-
- 🛠️ SSR, SPA, SSG, and In-Between
20-
- ⚡️ Instantly Visible Code Changes
21-
- 🔩 Existing Universe of Plugins
22-
- 🔑 Fully Typed APIs
23-
24-
## Documentation
25-
26-
Please see [the documentation](https://kit.svelte.dev/docs) for information about getting started and developing with SvelteKit.
5+
Web development, streamlined. Read the [documentation](https://kit.svelte.dev/docs) to get started.
276

287
### Packages
298

309
| Package | Changelog |
3110
| --------------------------------------------------------------------------- | ------------------------------------------------------------- |
3211
| [@sveltejs/kit](packages/kit) | [Changelog](packages/kit/CHANGELOG.md) |
33-
| [create-svelte](packages/create-svelte) | [Changelog](packages/create-svelte/CHANGELOG.md) |
34-
| [@sveltejs/adapter-node](packages/adapter-node) | [Changelog](packages/adapter-node/CHANGELOG.md) |
35-
| [@sveltejs/adapter-static](packages/adapter-static) | [Changelog](packages/adapter-static/CHANGELOG.md) |
36-
| [@sveltejs/adapter-cloudflare-workers](packages/adapter-cloudflare-workers) | [Changelog](packages/adapter-cloudflare-workers/CHANGELOG.md) |
12+
| [@sveltejs/adapter-auto](packages/adapter-auto) | [Changelog](packages/adapter-auto/CHANGELOG.md) |
3713
| [@sveltejs/adapter-cloudflare](packages/adapter-cloudflare) | [Changelog](packages/adapter-cloudflare/CHANGELOG.md) |
14+
| [@sveltejs/adapter-cloudflare-workers](packages/adapter-cloudflare-workers) | [Changelog](packages/adapter-cloudflare-workers/CHANGELOG.md) |
3815
| [@sveltejs/adapter-netlify](packages/adapter-netlify) | [Changelog](packages/adapter-netlify/CHANGELOG.md) |
16+
| [@sveltejs/adapter-node](packages/adapter-node) | [Changelog](packages/adapter-node/CHANGELOG.md) |
17+
| [@sveltejs/adapter-static](packages/adapter-static) | [Changelog](packages/adapter-static/CHANGELOG.md) |
3918
| [@sveltejs/adapter-vercel](packages/adapter-vercel) | [Changelog](packages/adapter-vercel/CHANGELOG.md) |
19+
| [@sveltejs/amp](packages/amp) | [Changelog](packages/amp/CHANGELOG.md) |
20+
| [@sveltejs/package](packages/package) | [Changelog](packages/package/CHANGELOG.md) |
21+
| [create-svelte](packages/create-svelte) | [Changelog](packages/create-svelte/CHANGELOG.md) |
22+
| [svelte-migrate](packages/migrate) | [Changelog](packages/migrate/CHANGELOG.md) |
4023

41-
The SvelteKit community also makes additional [SvelteKit adapters available for use](https://sveltesociety.dev/components#adapters).
42-
43-
### Migrating from Sapper
44-
45-
Check out the [Migration Guide](https://kit.svelte.dev/docs/migrating) if you are upgrading from Sapper.
46-
47-
## Bug reporting
48-
49-
Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from [Vite](https://vitejs.dev/), which is used to build a SvelteKit project. It's important to note that new Vite projects don't use SSR by default, and so if you create a new Vite project from scratch, many issues won't reproduce. You should thus start with a project that utilizes SSR, such as `npm create vite-extra@latest -- --template ssr-svelte`.
50-
51-
If an issue originates from Vite, please report it in the [Vite issue tracker](https://github.com/vitejs/vite/issues).
24+
[Additional adapters](<(https://sveltesociety.dev/components#adapters)>) are maintained by the community.
5225

53-
## Changing SvelteKit locally
26+
## Contributing
5427

55-
See the [Contributing Guide](./CONTRIBUTING.md).
28+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to develop SvelteKit locally.
5629

5730
## Supporting Svelte
5831

documentation/docs/10-getting-started/10-introduction.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ title: Introduction
44

55
## Before we begin
66

7-
> 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).
7+
> If you're new to Svelte or SvelteKit we recommend checking out the (experimental!) [interactive tutorial](https://learn.svelte.dev).
88
>
9-
> See the [migration guides](/docs/migrating) for help upgrading from Sapper.
9+
> If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat).
1010
1111
## What is SvelteKit?
1212

13-
SvelteKit is a framework for building extremely high-performance web apps.
13+
SvelteKit is a framework for rapid development of robust, performant web applications.
1414

15-
Building an app with all the modern best practices is fiendishly complicated. Those practices include [build optimizations](https://vitejs.dev/guide/features.html#build-optimizations), so that you load only the minimal required code; [offline support](/docs/service-workers); [preloading](/docs/link-options#data-sveltekit-preload-data) pages before the user initiates navigation; and [configurable rendering](/docs/page-options) that allows you to render your app [on the server](/docs/glossary#ssr) or [in the browser](/docs/glossary#csr-and-spa) at runtime or [at build-time](/docs/glossary#prerendering). SvelteKit does all the boring stuff for you so that you can get on with the creative part.
15+
Building an app with all the modern best practices is fiendishly complicated. Those practices include [build optimizations](https://vitejs.dev/guide/features.html#build-optimizations), so that you load only the minimal required code; [offline support](/docs/service-workers); [preloading](/docs/link-options#data-sveltekit-preload-data) pages before the user initiates navigation; [configurable rendering](/docs/page-options) that allows you to render your app [on the server](/docs/glossary#ssr) or [in the browser](/docs/glossary#csr-and-spa) at runtime or [at build-time](/docs/glossary#prerendering); and many other things. SvelteKit does all the boring stuff for you so that you can get on with the creative part.
1616

1717
It uses [Vite](https://vitejs.dev/) with a [Svelte plugin](https://github.com/sveltejs/vite-plugin-svelte) to provide a lightning-fast and feature-rich development experience with [Hot Module Replacement (HMR)](https://github.com/sveltejs/vite-plugin-svelte/blob/main/docs/config.md#hot), where changes to your code are reflected in the browser instantly.
1818

documentation/faq/10-version-numbers.md

-5
This file was deleted.

packages/create-svelte/bin.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ import { dist } from './utils.js';
99
// prettier-ignore
1010
const disclaimer = `
1111
${bold(cyan('Welcome to SvelteKit!'))}
12-
13-
${bold(red('This is release candidate software; expect bugs and missing features.'))}
14-
15-
Problems? Open an issue on ${cyan('https://github.com/sveltejs/kit/issues')} if none exists already.
1612
`;
1713

1814
const { version } = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8'));
@@ -180,7 +176,7 @@ async function main() {
180176
console.log(` ${i++}: ${bold(cyan('npm run dev -- --open'))}`);
181177

182178
console.log(`\nTo close the dev server, hit ${bold(cyan('Ctrl-C'))}`);
183-
console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}\n`);
179+
console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}`);
184180
}
185181

186182
main();

0 commit comments

Comments
 (0)