docs: Azure Static Web App deployment steps#7188
docs: Azure Static Web App deployment steps#7188Xiang-CH wants to merge 2 commits intoTanStack:mainfrom
Conversation
Added Azure Static Web App deployment instructions
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdded an "Azure Static Web App" hosting subsection to the React guide documenting copying a custom Nitro Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/start/framework/react/guide/hosting.md (2)
294-294: Avoid anchoring required deployment assets to a personal repository.Line 294 points to a contributor-owned repo for a required preset directory. This can break docs if the repo moves or changes. Prefer a TanStack-owned location (this repo docs/examples) or inline the preset content.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/start/framework/react/guide/hosting.md` at line 294, The docs currently link to a contributor-owned preset `azure-swa-custom` (the GitHub URL) for required deployment assets; replace that external personal repo reference by either copying the preset content directly into the docs/examples (inline the entire preset in the repo) or hosting the preset in a TanStack-owned location and updating the link to point to that canonical location, ensuring the guide references `azure-swa-custom` from the project-owned source rather than the contributor repo.
290-296: Fix wording/typos in the Azure SWA instructions.There are multiple grammar/spelling issues that make the steps harder to follow (e.g., Line 290 “proporly”, Line 296 “Update you”, Line 324 “If you App”). Please clean these up.
Proposed text edits
-Azure SWA uses [`Nitro`](`#nitro`) for deployment, but the Nitro preset `azure-swa` needs to be extended for it to work proporly. +Azure SWA uses [`Nitro`](`#nitro`) for deployment, but the Nitro preset `azure-swa` needs to be extended for it to work properly. -1. Copy this custom nitro preset [`azure-swa-custom`](https://github.com/Xiang-CH/tanstack-azure-swa-template/tree/main/nitro) (the entire directory) in to your project root. +1. Copy this custom Nitro preset [`azure-swa-custom`](https://github.com/Xiang-CH/tanstack-azure-swa-template/tree/main/nitro) (the entire directory) into your project root. -2. Update you `vite.config.ts` with the following Nitro configuration: +2. Update your `vite.config.ts` with the following Nitro configuration: -4. If you App location is not the project root the build config should be the following: +4. If your app location is not the project root, the build config should be the following:Also applies to: 324-324
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/start/framework/react/guide/hosting.md` around lines 290 - 296, Fix the typos and improve wording in the Azure SWA instructions: change "proporly" to "properly" in the sentence about the Nitro preset `azure-swa`, change "Update you `vite.config.ts`" to "Update your `vite.config.ts`", and change "If you App" to "If your App"; also smooth minor grammar (e.g., "Copy this custom nitro preset" → "Copy the custom Nitro preset `azure-swa-custom` to your project root") so the lines referencing the Nitro preset `azure-swa`, the custom preset `azure-swa-custom`, and the `vite.config.ts` update read clearly and consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/start/framework/react/guide/hosting.md`:
- Line 294: The docs currently link to a contributor-owned preset
`azure-swa-custom` (the GitHub URL) for required deployment assets; replace that
external personal repo reference by either copying the preset content directly
into the docs/examples (inline the entire preset in the repo) or hosting the
preset in a TanStack-owned location and updating the link to point to that
canonical location, ensuring the guide references `azure-swa-custom` from the
project-owned source rather than the contributor repo.
- Around line 290-296: Fix the typos and improve wording in the Azure SWA
instructions: change "proporly" to "properly" in the sentence about the Nitro
preset `azure-swa`, change "Update you `vite.config.ts`" to "Update your
`vite.config.ts`", and change "If you App" to "If your App"; also smooth minor
grammar (e.g., "Copy this custom nitro preset" → "Copy the custom Nitro preset
`azure-swa-custom` to your project root") so the lines referencing the Nitro
preset `azure-swa`, the custom preset `azure-swa-custom`, and the
`vite.config.ts` update read clearly and consistently.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7007ee59-e690-47c4-849c-6b447fc658e2
📒 Files selected for processing (1)
docs/start/framework/react/guide/hosting.md
Added Azure Static Web App deployment instructions
Summary by CodeRabbit