Skip to content

Commit

Permalink
docs: update nightly and experimental banners
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Nov 3, 2024
1 parent 66d955a commit 9ff3713
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 31 deletions.
7 changes: 2 additions & 5 deletions docs/1.guide/2.routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,6 @@ export default defineEventHandler(event => {

### Environment specific handlers

> [!NOTE]
> This feature is currently available in [nightly channel](https://nitro.build/guide/nightly) only.
You can specify for a route that will only be included in specific builds by adding a `.dev`, `.prod` or `.prerender` suffix to the file name, for example: `routes/test.get.dev.ts` or `routes/test.get.prod.ts`.

> [!TIP]
Expand Down Expand Up @@ -210,8 +207,8 @@ Returning anything from a middleware will close the request and should be avoide

You can define route handler meta at build-time using `defineRouteMeta` micro in the event handler files.

> [!NOTE]
> This feature is currently available in [nightly channel](https://nitro.build/guide/nightly) only.
> [!IMPORTANT]
> 🚧 This feature is currently experimental.
```ts [/api/test.ts]
defineRouteMeta({
Expand Down
5 changes: 0 additions & 5 deletions docs/2.deploy/10.runtimes/_winterjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ You can easily build Nitro powered applications to run with [wasmerio/winterjs](
[WinterJS](https://github.com/wasmerio/winterjs) is a JavaScript Service Workers server written in Rust, that uses the SpiderMonkey runtime to execute JavaScript (the same runtime that Firefox uses) ([announcement](https://wasmer.io/posts/announcing-winterjs-service-workers)).


::warning
🌙 WinterJS is currently supported in **nightly release channel**. Read the docs for using [Nightly Release Channel](/guide/getting-started#nightly-release-channel).
::


::warning
🚧 WinterJS runtime is unstable and under heavy development. Follow [nitrojs/nitro#1861](https://github.com/nitrojs/nitro/issues/1861) for status and information.
::
Expand Down
19 changes: 9 additions & 10 deletions docs/2.deploy/20.providers/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,16 @@ export default defineNuxtConfig({
::


## Streaming support (experimental)

**Preset:** `aws_lambda_streaming`

Nitro supports an experimental preset to generate output format compatible with [AWS Lambda](https://aws.amazon.com/lambda/) with streaming invoke turned on.
## Response streaming

:read-more{title="Introducing AWS Lambda response streaming" to="https://aws.amazon.com/blogs/compute/introducing-aws-lambda-response-streaming/"}

> [!NOTE]
> This preset available via [nightly channel](https://nitro.build/guide/nightly) to try.
> [!IMPORTANT]
> This preset is not production ready and might be renamed! Please don't advice users or document to indirectly use it.
In order to enable response streaming, enable `awsLambda.streaming` flag:

```ts [nitro.config.ts]
export default defineNitroConfig({
awsLambda: {
streaming: true
}
});
```
5 changes: 2 additions & 3 deletions docs/2.deploy/20.providers/genezio.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@

:read-more{title="Genezio" to="https://genezio.com"}

> [!NOTE]
> This preset available via [nightly channel](https://nitro.build/guide/nightly) to try.
> [!IMPORTANT]
> 🚧 This preset is currently experimental.
## 1. Project Setup

Expand Down
3 changes: 0 additions & 3 deletions docs/2.deploy/20.providers/vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,6 @@ To revalidate a page on demand:

### Fine-grained ISR config via route rules

> [!IMPORTANT]
> Fine-grained ISR config is currently possible by using the [nightly channel](https://nitro.build/guide/nightly).

By default, query paramas are ignored by cache.

You can pass an options object to `isr` route rule to configure caching behavior.
Expand Down
4 changes: 2 additions & 2 deletions docs/2.deploy/20.providers/zerops.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

:read-more{title="zerops.io" to="https://zerops.io"}

> [!NOTE]
> This preset available via [nightly channel](https://nitro.build/guide/nightly) to try.
> [!IMPORTANT]
> 🚧 This preset is currently experimental.
Zerops supports deploying both static and server-side rendered apps with a simple configuration file in your project root.

Expand Down
3 changes: 0 additions & 3 deletions docs/3.config/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,6 @@ Enable experimental features.

Enable `/_nitro/scalar`, `/_nitro/swagger` and `/_nitro/openapi.json` endpoints.

> [!IMPORTANT]
> These endpoints are moving to `/_scalar`, `/_swagger` and `/_openapi.json` in [nightly channel](/guide/nightly) and [nitro v3](https://github.com/nitrojs/nitro/pull/2521).
- Default: `false`

You can pass an object on the root level to modify your OpenAPI specification:
Expand Down

0 comments on commit 9ff3713

Please sign in to comment.