docs: make Netlify hosting docs precise and actionable #5747
+80
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughNetlify hosting docs for React and Solid were expanded with explicit plugin installation commands, updated Vite config examples showing plugin usage, added Netlify CLI deployment instructions, preserved netlify.toml guidance, and an "Other deployment methods" section with links. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant Vite as Vite (build)
participant NetlifyCLI as Netlify CLI
participant Netlify as Netlify
rect rgba(200,230,255,0.3)
Dev->>Vite: add `@netlify/vite-plugin-tanstack-start` plugin
Dev->>Vite: run build (vite)
end
rect rgba(200,255,200,0.2)
Dev->>NetlifyCLI: npx netlify deploy --prod (or interactive)
NetlifyCLI->>Netlify: upload assets / trigger deploy
Netlify-->>Dev: deploy status / URL
end
note over NetlifyCLI,Netlify: Alternative flows documented: netlify.toml, Netlify app build settings, Git-based deploys
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit 72974cc
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/arktype-adapter
@tanstack/directive-functions-plugin
@tanstack/eslint-plugin-router
@tanstack/history
@tanstack/nitro-v2-vite-plugin
@tanstack/react-router
@tanstack/react-router-devtools
@tanstack/react-router-ssr-query
@tanstack/react-start
@tanstack/react-start-client
@tanstack/react-start-server
@tanstack/router-cli
@tanstack/router-core
@tanstack/router-devtools
@tanstack/router-devtools-core
@tanstack/router-generator
@tanstack/router-plugin
@tanstack/router-ssr-query-core
@tanstack/router-utils
@tanstack/router-vite-plugin
@tanstack/server-functions-plugin
@tanstack/solid-router
@tanstack/solid-router-devtools
@tanstack/solid-router-ssr-query
@tanstack/solid-start
@tanstack/solid-start-client
@tanstack/solid-start-server
@tanstack/start-client-core
@tanstack/start-plugin-core
@tanstack/start-server-core
@tanstack/start-static-server-functions
@tanstack/start-storage-context
@tanstack/valibot-adapter
@tanstack/virtual-file-routes
@tanstack/zod-adapter
commit: |
Revamp the Netlify hosting docs again, to provide a single golden default path that is precise and works for most use cases, and call out alternatives separately in subsections. Also add links out to further Netlify docs where appropriate to increase discoverability and troubleshootability.
serhalp
force-pushed
the
fix/add-netlify-docs-links
branch
from
63eeae8 to
72974cc
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/start/framework/react/guide/hosting.md(2 hunks)docs/start/framework/solid/guide/hosting.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)
Files:
docs/start/framework/react/guide/hosting.mddocs/start/framework/solid/guide/hosting.md
docs/{router,start}/**
📄 CodeRabbit inference engine (AGENTS.md)
Place router docs under docs/router/ and start framework docs under docs/start/
Files:
docs/start/framework/react/guide/hosting.mddocs/start/framework/solid/guide/hosting.md
🪛 markdownlint-cli2 (0.18.1)
docs/start/framework/react/guide/hosting.md
192-192: Link text should be descriptive
(MD059, descriptive-link-text)
docs/start/framework/solid/guide/hosting.md
186-186: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Preview
🔇 Additional comments (2)
docs/start/framework/solid/guide/hosting.md (1)
126-160: Well-structured golden path with clear setup steps.The Netlify CLI-first deployment approach with proper installation instructions, config updates, and deployment commands provides an excellent primary path for users.
docs/start/framework/react/guide/hosting.md (1)
132-166: Consistent and comprehensive Netlify deployment guidance.This matches the Solid framework structure and provides users with clear installation, configuration, and deployment steps. The Netlify CLI approach is set as the primary path while preserving manual configuration as an alternative.
Comment on lines
+184
to
+192
| #### 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/). |
There was a problem hiding this comment.
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.
Comment on lines
+178
to
+186
| #### 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/). |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Revamp the Netlify hosting docs again so that they:
Also add links out to further Netlify docs where appropriate to increase discoverability and troubleshootability.
Summary by CodeRabbit