Skip to content

Docs update - #236

Merged
montalvomiguelo merged 5 commits into
mainfrom
docs-update-011926
Jan 19, 2026
Merged

montalvomiguelo merged 5 commits into
mainfrom
docs-update-011926

Conversation

@montalvomiguelo

@montalvomiguelo montalvomiguelo commented Jan 19, 2026 •

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Expanded troubleshooting guide with clearer tunneling guidance and explicit instructions for enabling tunnel support, including an ngrok example.
    • Noted automatic configuration when tunneling is enabled and how custom server settings take precedence.
    • Broadened host allowances and CORS origin examples to cover localhost/loopback and Shopify domain variants for local and remote testing.
    • Improved configuration examples and code-block formatting for step-by-step setup.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 19, 2026 •

Copy link
Copy Markdown

Warning

Rate limit exceeded

@montalvomiguelo has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 65aae1c and 1dcfc99.

📒 Files selected for processing (1)
  • docs/guide/troubleshooting.md
📝 Walkthrough

Walkthrough

Updated troubleshooting docs to show a Vite dev-server config that enables the Shopify plugin tunnel (shopify({ tunnel: true })), adds server.allowedHosts: ['.trycloudflare.com'], and expands server.cors.origin to include a localhost/loopback regex and /.+\.myshopify\.com$/.

Changes

Cohort / File(s) Summary
Documentation - Vite config example
docs/guide/troubleshooting.md
Rewrote Vite dev-server example to enable shopify({ tunnel: true }), add server.allowedHosts: ['.trycloudflare.com'], and replace defaultAllowedOrigins with explicit server.cors.origin entries (including a localhost/loopback regex and /.+\.myshopify\.com$/). Reordered and reformatted code blocks; added ngrok tunneling example and a "Tip Automatic Configuration (v4.1.0+)" note.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I nudged the docs, a hop in the night,
tunnel on, localhost shining bright,
regex stitched, Cloudflare at the door,
devs can test without CORS uproar,
nibble on code and dream some more 🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Docs update' is too vague and generic, failing to convey what specific documentation changes were made, such as tunnel configuration or server settings. Use a more specific title that describes the actual changes, such as 'Add tunnel configuration and server settings examples to troubleshooting guide'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify

netlify Bot commented Jan 19, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for bespoke-flan-5eacfc ready!

Name Link
🔨 Latest commit 1dcfc99
🔍 Latest deploy log https://app.netlify.com/projects/bespoke-flan-5eacfc/deploys/696e6614baca5000077dfe02
😎 Deploy Preview https://deploy-preview-236--bespoke-flan-5eacfc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/guide/troubleshooting.md`:
- Around line 125-142: The snippet is missing top-level imports and the closing
braces for the exported config; add imports for defineConfig, shopify and your
Tailwind plugin (referencing defineConfig, shopify, tailwindcss) at the top,
then close the default export object and the file (replace the stray
build.rollupOptions fragment with either a completed build.rollupOptions object
or a comment like "// build.rollupOptions omitted for brevity" if you intend to
continue it) so the file parses and the export default defineConfig({...}) is
properly closed.
🧹 Nitpick comments (1)
docs/guide/troubleshooting.md (1)

135-135: Consider strengthening the myshopify.com CORS pattern.

The current regex /\.myshopify\.com$/ doesn't enforce HTTPS or anchor at the start of the origin. Since Shopify stores use HTTPS, consider a more restrictive pattern:

-        /\.myshopify\.com$/,
+        /^https:\/\/[^\/]+\.myshopify\.com$/,

This ensures:

  • Only HTTPS connections are allowed
  • Proper start-of-string anchoring
  • Prevents potential edge cases with malformed origins

Comment thread docs/guide/troubleshooting.md
@montalvomiguelo
montalvomiguelo merged commit bf227be into main Jan 19, 2026
11 checks passed
montalvomiguelo added a commit to montalvomiguelo/shopify-vite that referenced this pull request Aug 16, 2026
* Add release workflow (barrel#185)

* Output modulepreload tags only when configured (barrel#186)

* Version Packages

* Add vite 7 support (barrel#190)

* Version Packages (barrel#191)

* Add vite 7 support (barrel#201)

* Version Packages (barrel#202)

* Add Shopify strict Liquid parser support with 'asset' variable (barrel#208)

* Version Packages (barrel#209)

* Replace npm tokens with OIDC trusted publishing (barrel#210)

* Chrome Local Network Access Update & Tunnel Fix (barrel#211)

* Recommended config (barrel#214)

* Tunnel fix and cors defaults (barrel#215)

* Version Packages (barrel#216)

* Run CI with node 24 (barrel#217)

* Update references to vite-plugin-shopify-clean (barrel#220)

* Fix modulepreload tag generation condition (barrel#223)

* Update dependencies (barrel#225)

* Update pnpm-lock.yaml to sync with package.json (barrel#226)

* Version Packages (barrel#224)

* fix allowedHosts placement in vite config file (barrel#235)

allowedHosts need to be in server for the Shopify theme editor to display correctly in local environment

* Docs update (barrel#236)

* Add vite 8 support (barrel#242)

* Version Packages (barrel#243)

* Mitigating supply chain attacks

Bump pnpm to 10.34.5 and fix allowBuilds

Clarify allowBuilds comment wording

* Bump deps on @shopify/cli-kit

Declare Node >=22.12.0 engines on vite-plugin-shopify

* Bump deps on vitest

* Bump deps on eslint and fix lint errors

Enable type-aware ESLint and fix fallout

Update typescript version

Use import type for Vite types in liquid-no-refresh test

Drop Node 20 from CI and fix the version matrix

Fix debounce generic breaking page-reload DTS build

* Update snapshots

* Add release note

* Update CI

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Wes Turner-Harris <wes.turner@barrelny.com>
Co-authored-by: Jonathan Moore <jonathan@stylehatch.com>
Co-authored-by: Maria Carter <maria@driver-digital.com>
Co-authored-by: Jade W. <140425997+jadewang425@users.noreply.github.com>
Co-authored-by: Miguel Montalvo <miguel.montalvo@meetdomaine.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants