docs: Update README for translated pathnames#6888
docs: Update README for translated pathnames#6888caweidmann wants to merge 1 commit intoTanStack:mainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation additions for integrating Paraglide with TanStack Start, including code examples for declaring translated pathnames in i18n/lib.ts and configuring the Vite plugin with urlPatterns in vite.config.ts. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 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 |
Bundle Size Benchmarks
Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
examples/react/start-i18n-paraglide/README.md (1)
192-206: Helpful example showing the import pattern.The code block effectively demonstrates how to import and use the
translatedPathnamesin the Vite configuration. The import path is consistent with the file structure established in the previous section.Minor enhancement suggestion: The transition text at line 192 could be more explicit about updating
vite.config.ts:-And import into the Paraglide Vite plugin. +Update your `vite.config.ts` to import and use the `translatedPathnames`:This makes it immediately clear where to add the code.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/react/start-i18n-paraglide/README.md` around lines 192 - 206, Update the transitional sentence before the code block to explicitly tell the reader to add the import and plugin option to their Vite configuration: mention that they should open their Vite config and import translatedPathnames, then pass it to paraglideVitePlugin via the urlPatterns option (as shown in the code block using translatedPathnames and paraglideVitePlugin) so it's clear where to place the snippet.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@examples/react/start-i18n-paraglide/README.md`:
- Around line 192-206: Update the transitional sentence before the code block to
explicitly tell the reader to add the import and plugin option to their Vite
configuration: mention that they should open their Vite config and import
translatedPathnames, then pass it to paraglideVitePlugin via the urlPatterns
option (as shown in the code block using translatedPathnames and
paraglideVitePlugin) so it's clear where to place the snippet.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 2be8512a-e09e-48a2-8396-8dfe0116ba6c
📒 Files selected for processing (1)
examples/react/start-i18n-paraglide/README.md
Summary by CodeRabbit