Skip to content

docs: make Netlify hosting docs precise and actionable #5747

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 4, 2025
+80 −10
Merged

docs: make Netlify hosting docs precise and actionable #5747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions docs/start/framework/react/guide/hosting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,21 +129,45 @@ A full TanStack Start example for Cloudflare Workers is available [here](https:/

### Netlify

Install and add the [`@netlify/vite-plugin-tanstack-start`](https://www.npmjs.com/package/@netlify/vite-plugin-tanstack-start) plugin, which configures your build for Netlify deployment and provides full Netlify production platform emulation in local dev.
Install and add the [`@netlify/vite-plugin-tanstack-start`](https://www.npmjs.com/package/@netlify/vite-plugin-tanstack-start) plugin, which configures your build for Netlify deployment and provides full Netlify production platform emulation in local dev:

```bash
npm install --save-dev @netlify/vite-plugin-tanstack-start
# or...
pnpm add --save-dev @netlify/vite-plugin-tanstack-start
# or yarn, bun, etc.
```

```ts
// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/react-start/plugin/vite'
import netlify from '@netlify/vite-plugin-tanstack-start'
import netlify from '@netlify/vite-plugin-tanstack-start' // ← add this
import viteReact from '@vitejs/plugin-react'

export default defineConfig({
plugins: [tanstackStart(), netlify(), viteReact()],
plugins: [
tanstackStart(),
netlify(), // ← add this (anywhere in the array is fine)
viteReact(),
],
})
```

Add a `netlify.toml` file to your project root:
Finally, use [Netlify CLI](https://developers.netlify.com/cli/) to deploy your app:

```bash
npx netlify deploy
```

If this is a new Netlify project, you'll be prompted to initialize it and build settings will be automatically configured for you.

For more detailed documentation, check out the full [TanStack Start on Netlify
docs](https://docs.netlify.com/build/frameworks/framework-setup-guides/tanstack-start/).

#### Manual configuration

Alternatively, if you prefer manual configuration, you can add a `netlify.toml` file to your project root:

```toml
[build]
Expand All @@ -154,7 +178,18 @@ Add a `netlify.toml` file to your project root:
port = 3000
```

Deploy your application using their one-click deployment process, and you're ready to go!
Or you can set the above settings directly [in the Netlify
app](https://docs.netlify.com/build/configure-builds/overview/#build-settings).

#### Other deployment methods

Netlify also supports other deployment methods, such as [continuous deployment from a git repo
hosted on GitHub, GitLab, or
others](https://docs.netlify.com/start/quickstarts/deploy-from-repository/), [starting from a
template](https://docs.netlify.com/start/quickstarts/deploy-from-template/), [deploying or
importing from an AI code generation
tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/), and
[more](https://docs.netlify.com/deploy/create-deploys/).
Comment on lines +184 to +192
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Improve link text descriptiveness for the "more" link.

The link text "[more]" at line 192 should be more descriptive to improve discoverability and clarify what users will find. This mirrors the same issue in the Solid framework documentation.

Apply this diff:

-tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/), and
-[more](https://docs.netlify.com/deploy/create-deploys/).
+tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/).

Then add:

+and [more deployment methods](https://docs.netlify.com/deploy/create-deploys/).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

192-192: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents 
In docs/start/framework/react/guide/hosting.md around lines 184 to 192, replace
the non‑descriptive link text "[more]" with a clearer, descriptive phrase such
as "additional Netlify deployment options" (or "learn about additional Netlify
deployment methods") so the link text explains what users will find; update the
link anchor only (keeping the same URL) and ensure the wording matches
surrounding sentence grammar.


### Nitro

Expand Down
45 changes: 40 additions & 5 deletions docs/start/framework/solid/guide/hosting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,45 @@ Deploy your application to Cloudflare Workers using their one-click deployment p

### Netlify

Install and add the [`@netlify/vite-plugin-tanstack-start`](https://www.npmjs.com/package/@netlify/vite-plugin-tanstack-start) plugin, which configures your build for Netlify deployment and provides full Netlify production platform emulation in local dev.
Install and add the [`@netlify/vite-plugin-tanstack-start`](https://www.npmjs.com/package/@netlify/vite-plugin-tanstack-start) plugin, which configures your build for Netlify deployment and provides full Netlify production platform emulation in local dev:

```bash
npm install --save-dev @netlify/vite-plugin-tanstack-start
# or...
pnpm add --save-dev @netlify/vite-plugin-tanstack-start
# or yarn, bun, etc.
```

```ts
// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import netlify from '@netlify/vite-plugin-tanstack-start'
import netlify from '@netlify/vite-plugin-tanstack-start' // ← add this
import viteSolid from 'vite-plugin-solid'

export default defineConfig({
plugins: [tanstackStart(), netlify(), viteSolid({ ssr: true })],
plugins: [
tanstackStart(),
netlify(), // ← add this (anywhere in the array is fine)
viteSolid({ ssr: true }),
],
})
```

Add a `netlify.toml` file to your project root:
Finally, use [Netlify CLI](https://developers.netlify.com/cli/) to deploy your app:

```bash
npx netlify deploy
```

If this is a new Netlify project, you'll be prompted to initialize it and build settings will be automatically configured for you.

For more detailed documentation, check out the full [TanStack Start on Netlify
docs](https://docs.netlify.com/build/frameworks/framework-setup-guides/tanstack-start/).

#### Manual configuration

Alternatively, if you prefer manual configuration, you can add a `netlify.toml` file to your project root:

```toml
[build]
Expand All @@ -148,7 +172,18 @@ Add a `netlify.toml` file to your project root:
port = 3000
```

Deploy your application using their one-click deployment process, and you're ready to go!
Or you can set the above settings directly [in the Netlify
app](https://docs.netlify.com/build/configure-builds/overview/#build-settings).

#### Other deployment methods

Netlify also supports other deployment methods, such as [continuous deployment from a git repo
hosted on GitHub, GitLab, or
others](https://docs.netlify.com/start/quickstarts/deploy-from-repository/), [starting from a
template](https://docs.netlify.com/start/quickstarts/deploy-from-template/), [deploying or
importing from an AI code generation
tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/), and
[more](https://docs.netlify.com/deploy/create-deploys/).
Comment on lines +178 to +186
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Improve link text descriptiveness for the "more" link.

The link text "[more]" at line 186 is not descriptive and doesn't clearly indicate what users will find at the destination. Consider updating it to something like "more deployment methods" to improve discoverability.

Apply this diff:

-and
+and [more deployment methods](https://docs.netlify.com/deploy/create-deploys/).

And adjust the preceding text:

-tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/), and
-[more](https://docs.netlify.com/deploy/create-deploys/).
+tool](https://docs.netlify.com/start/quickstarts/deploy-from-ai-code-generation-tool/).

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

186-186: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents 
In docs/start/framework/solid/guide/hosting.md around lines 178 to 186, the link
text "[more]" is not descriptive; update the link label to something clear like
"more deployment methods" and adjust the preceding sentence so it reads
naturally (for example: "...and more deployment methods.") ensuring the link URL
remains https://docs.netlify.com/deploy/create-deploys/ and the sentence
punctuation and spacing are correct.


### Nitro

Expand Down
Loading