Skip to content

Commit

Permalink
Update Turbopack docs for beta release (#4769)
Browse files Browse the repository at this point in the history
Closes WEB-912

---------

Co-authored-by: Alex Kirszenberg <alex.kirszenberg@vercel.com>
  • Loading branch information
2 people authored and gsoltis committed May 5, 2023
1 parent 4741caa commit 87c6620
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/components/pages/landing/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ function SiteCards() {
className="turbopackCardBg"
>
<div className="absolute top-3 left-3">
<CardBadge>alpha</CardBadge>
<CardBadge>beta</CardBadge>
</div>
<p className="text-lg !w-[280px] md:!w-[340px] font-space-grotesk text-center opacity-50 dark:opacity-70 ">
Introducing the Rust-powered successor to Webpack.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/pack/docs/comparisons/webpack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ In a 1,000 module application, Turbopack can react to file changes **<DocsBenchm

webpack has an extraordinary collection of [plugins](https://webpack.js.org/plugins/) to customize its behavior. Composing plugins lets you create custom toolchains which can support a huge variety of bundler features.

In its alpha state, Turbopack cannot currently be configured with plugins. In the future, we plan to make Turbopack just as extensible as webpack - though likely with an altered API.
As of Next.js 13.2, Turbopack introduced a compatibility layer to support webpack's loaders and resolve aliases. See [Customizing Turbopack](features/customizing-turbopack) for how to configure them. In the future, we plan to make Turbopack just as extensible as webpack - though likely with an altered API.
2 changes: 1 addition & 1 deletion docs/pages/pack/docs/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When building a bundler, we needed to consider which features would be:
- **Available via plugins**: usually installed from a registry and configured
- **Unavailable**: not available at all

**Turbopack is in alpha**, so very few of these decisions are set in stone. In its current state, **Turbopack cannot yet be configured** - so plugins are not available yet.
**Turbopack is in beta**, so very few of these decisions are set in stone. In its current state, **Turbopack cannot yet be configured** - so plugins are not available yet.

Let's discuss which features are available out-of-the-box, in Turbopack's default configuration. We'll also touch on features which will be configurable via plugins.

Expand Down
10 changes: 2 additions & 8 deletions docs/pages/pack/docs/features/frameworks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,12 @@ Turbopack has been built from the ground up to solve these problems - it works w

## Next

Turbopack's Alpha version has been focused on providing a great experience for Next.js's dev server. We're using this as our initial goal to show what Turbopack can do. In the future, we want Turbopack to act as a low-level engine for other frameworks.

This means that Turbopack plans to support everything in Next.js.

### `next/dynamic`

[`next/dynamic`](https://nextjs.org/docs/advanced-features/dynamic-import) is not yet supported - however, we plan to support it out of the box soon.
To begin with, Turbopack is focused on providing a great experience for Next.js's dev server. We're using this as our initial goal to show what Turbopack can do. In the future, we want Turbopack to act as a low-level engine for other frameworks.

## Vue and Svelte

[VueJS](https://vuejs.org/) and [Svelte](https://svelte.dev/) are tremendously popular frameworks which deliver a world-class developer experience.

Since Turbopack is in alpha, we're focusing our support on Next.js's dev server. That means that right now, Vue and Svelte don't work out of the box.
Since Turbopack is in beta, we're focusing our support on Next.js's dev server. That means that right now, Vue and Svelte don't work out of the box.

In future versions, we'll be supporting Vue and Svelte via plugins.
8 changes: 0 additions & 8 deletions docs/pages/pack/docs/features/imports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,6 @@ const { add } = require('./math');
add(1, 2);
```

We also support dynamic `require()` syntax, for if you want to import a dynamically named asset:

```ts
const imgName = getRandomImgName();

const img = require(`./images/${imgName}.png`);
```

## ESM

Importing via the `import` syntax is also supported out-of-the-box. This includes static assets, and `import type`:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/pack/docs/features/javascript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Turbopack supports Browserslist **out-of-the-box**. We pass the information we f
This means you can feel comfortable using Turbopack to target legacy browsers, or deciding to only ship code to modern browsers.

<Callout type="info">
Turbopack is available in alpha preview with a dev server, which uses a pre-set minimal browserslist to minimize transformation during development. In a future release, Turbopack will build apps for production targeting your defined browserslist.
Turbopack is available in beta preview with a dev server, which uses a pre-set minimal browserslist to minimize transformation during development. In a future release, Turbopack will build apps for production targeting your defined browserslist.
</Callout>

## Babel
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/pack/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The secret to Turbopack's performance is twofold: highly optimized machine code
Our team has taken the lessons from 10 years of webpack, combined with the innovations in incremental computation from [Turborepo](/repo) and Google's Bazel, and created an architecture ready to support the coming decades of computing.

<Callout type="error">
Turbopack is currently in <strong>alpha</strong>. It is not yet ready for production use. We appreciate your support and feedback as we work to make it ready for everyone.
Turbopack is currently in <strong>beta</strong>. It is not yet ready for production use. We appreciate your support and feedback as we work to make it ready for everyone.
</Callout>

## Quickstart
Expand Down

0 comments on commit 87c6620

Please sign in to comment.