Skip to content

docs: add TanStack Start quickstart and overview#107

Open
moss-bryophyta wants to merge 3 commits intomainfrom
moss/tanstack-start-docs
Open

docs: add TanStack Start quickstart and overview#107
moss-bryophyta wants to merge 3 commits intomainfrom
moss/tanstack-start-docs

Conversation

@moss-bryophyta
Copy link
Copy Markdown
Collaborator

What

Adds documentation for gt-tanstack-start:

  • Overview — API walkthrough covering initializeGT, GTProvider, getTranslations, <T>, and <LocaleSelector>
  • Quickstart — step-by-step setup guide with installation, configuration, usage, translation generation, testing, and deployment

Links to the companion example app PR: generaltranslation/gt#1080

Important notes for review

Several issues found during testing that are documented in the quickstart:

  1. <T> must be imported from gt-react, not gt-tanstack-start — the CLI doesn't recognize gt-tanstack-start as a library and won't find translatable content otherwise
  2. gt-react must be a direct dependency — same reason (CLI only checks direct deps)
  3. Translation files must be in src/, not public/ — Vite dynamic imports require this

These are workarounds for the current state. Filed as feedback for the library team.

Per Ernest's feedback: SSG and middleware are more pertinent than the
<T> guide and dynamic content guide for example app links.
Adds gt-tanstack-start docs:
- Overview page with API walkthrough
- Quickstart with step-by-step setup guide
- Links to companion example app in generaltranslation/gt

Added to the sidebar between React and React Native.
@moss-bryophyta moss-bryophyta requested a review from a team as a code owner March 6, 2026 17:50
@moss-bryophyta moss-bryophyta enabled auto-merge (squash) March 6, 2026 17:50
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