Skip to content

docs: Update README for translated pathnames#6888

Open
caweidmann wants to merge 1 commit intoTanStack:mainfrom
caweidmann:patch-1
Open

docs: Update README for translated pathnames#6888
caweidmann wants to merge 1 commit intoTanStack:mainfrom
caweidmann:patch-1

Conversation

@caweidmann
Copy link

@caweidmann caweidmann commented Mar 11, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive integration guide for Paraglide with TanStack Start, including configuration examples, type-safe routing setup patterns, and detailed implementation instructions. The guide provides practical code examples, configuration workflow details, and step-by-step setup documentation to help developers implement application internationalization with proper pathname management.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation
examples/react/start-i18n-paraglide/README.md
Adds i18n helper and Vite plugin configuration code examples demonstrating translated pathname declaration and urlPatterns integration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hopping through docs, we plant a seed,
i18n pathways for all to read,
Paraglide takes flight with Vite's embrace,
Configuration examples light the way with grace! 🌍✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: Update README for translated pathnames' accurately describes the main change: adding documentation about translated pathnames to the README file.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@github-actions
Copy link
Contributor

Bundle Size Benchmarks

  • Commit: 870cf2806695
  • Measured at: 2026-03-11T10:18:16.387Z
  • Baseline source: history:870cf2806695
  • Dashboard: bundle-size history
Scenario Current (gzip) Delta vs baseline Raw Brotli Trend
react-router.minimal 87.09 KiB 0 B (0.00%) 274.11 KiB 75.68 KiB ▁▁▁▁▆▆▇▇███
react-router.full 90.08 KiB 0 B (0.00%) 284.36 KiB 78.32 KiB ▁▁▁▁▅▅▆▆███
solid-router.minimal 36.42 KiB 0 B (0.00%) 109.29 KiB 32.74 KiB ▁▁▁▁▅▆▇▇███
solid-router.full 40.75 KiB 0 B (0.00%) 122.27 KiB 36.58 KiB ▁▁▁▁▄▅▇▇███
vue-router.minimal 52.29 KiB 0 B (0.00%) 149.34 KiB 47.01 KiB ▁▁▁▁▅▅▇▇███
vue-router.full 57.08 KiB 0 B (0.00%) 164.85 KiB 51.27 KiB ▁▁▁▁▅▅▇▇███
react-start.minimal 99.66 KiB 0 B (0.00%) 313.26 KiB 86.22 KiB ▁▁▁▁▅▅▇▇███
react-start.full 102.97 KiB 0 B (0.00%) 322.99 KiB 89.07 KiB ▁▁▁▁▅▅▆▆███
solid-start.minimal 48.75 KiB 0 B (0.00%) 146.89 KiB 43.14 KiB ▁▁▁▁▅▅▇▇███
solid-start.full 54.21 KiB 0 B (0.00%) 162.75 KiB 47.88 KiB ▁▁▁▁▅▅▇▇███

Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 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 translatedPathnames in 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

📥 Commits

Reviewing files that changed from the base of the PR and between 870cf28 and 0d21bfa.

📒 Files selected for processing (1)
  • examples/react/start-i18n-paraglide/README.md

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.

1 participant