Skip to content
Source
Sign inSign up
TanStack/router

display auth, query, static examples on tanstack.com #5563

Mergedbirkskyum(GitHub profile, opens in a new tab)merged 2 commits intomain fromrefs/pull/5563/headmerged by birkskyum(GitHub profile, opens in a new tab)

Expanding the list of solid examples now that solid-router-ssr-query is functional

Summary by CodeRabbit

  • New Features
    • Added new example projects for Solid and React frameworks, including Kitchen Sink + Solid Query (file-based and code-based), Basic + Solid Query, Basic + DIY Auth, and Basic + Static rendering variants.
    • React Basic + Static rendering example now available.
    1. Walkthrough

      Two documentation configuration files are updated to register new framework examples: docs/router/config.json adds two Solid Query-based Kitchen Sink variants, and docs/start/config.json adds four example entries across React and Solid frameworks including Basic with Static rendering, Solid Query, and DIY Auth.

      Changes

      Cohort / File(s)Summary
      Documentation Example Configuration
      docs/router/config.json, docs/start/config.json
      Added new example entries to Solid framework section (Kitchen Sink + Solid Query variants, Basic + Solid Query, Basic + DIY Auth, Basic + Static rendering) and React framework section (Basic + Static rendering).

      Estimated code review effort

      🎯 1 (Trivial) | ⏱️ ~3 minutes

      • TanStack/router#5441 — Also modifies docs/start/config.json to add and update framework sections and navigation entries including Solid examples.
      • TanStack/router#5443 — Also modifies docs/router/config.json affecting documentation configuration structure and framework example entries.

      Poem

      Hoppy updates to our docs so bright, New examples crafted with delight, Solid frameworks, React with care, Kitchen Sink and Basics everywhere! Configuration grows with every bound— The perfect recipes we've found! 🐰✨

      Pre-merge checks and finishing touches

      ✅ Passed checks (3 passed)
      Check nameStatusExplanation
      Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
      Title Check✅ PassedThe PR title "display auth, query, static examples on tanstack.com" directly aligns with the changes in the pull request. The raw summary confirms that the changeset adds four new example entries to docs/start/config.json (React: Basic + Static rendering, and Solid: Basic + Solid Query, Basic + DIY Auth, and Basic + Static rendering) and two new Solid examples to docs/router/config.json. The title accurately captures the types of examples being added (auth, query, and static) and their destination (tanstack.com configuration files). The title is concise, clear, and specific enough for someone reviewing the history to understand that new example categories are being displayed on the site.
      Docstring Coverage✅ PassedNo functions found in the changes. Docstring coverage check skipped.
      ✨ Finishing touches
      🧪 Generate unit tests (beta)
      • Create PR with unit tests
      • Post copyable unit tests in a comment
      • Commit unit tests in branch `display-more-examples-on-tanstack-dot-com`

      📜 Recent review details

      Configuration used: CodeRabbit UI

      Review profile: CHILL

      Plan: Pro

      📥 Commits

      Reviewing files that changed from the base of the PR and between 616a38e76bfa6736d0cb119df885c54325181b7a and 4752b721d2478e93752d8a3ab5f6ec5ed3fbac06.

      📒 Files selected for processing (2)
      • docs/router/config.json (1 hunks)
      • docs/start/config.json (2 hunks)
      🧰 Additional context used
      📓 Path-based instructions (1)
      docs/{router,start}/**

      📄 CodeRabbit inference engine (AGENTS.md)

      Place router docs under docs/router/ and start framework docs under docs/start/

      Files:

      • docs/start/config.json
      • docs/router/config.json
      🧠 Learnings (1)
      📓 Common learnings
      Learnt from: CR
      PR: TanStack/router#0
      File: AGENTS.md:0-0
      Timestamp: 2025-09-23T17:36:12.598Z
      Learning: Applies to docs/{router,start}/** : Place router docs under docs/router/ and start framework docs under docs/start/
      🔇 Additional comments (3)
      docs/start/config.json (2)

      296-299: Add React + Static rendering example to start config.

      Good addition following the existing naming convention with "start-basic-static" as the path.


      313-324: All referenced Solid and React examples exist in the repository.

      Verified that all four referenced example directories are present:

      • examples/solid/start-basic-solid-query/
      • examples/solid/start-basic-auth/
      • examples/solid/start-basic-static/
      • examples/react/start-basic-static/

      Naming follows established patterns with kebab-case and the "start-" prefix, consistent across React and Solid examples.

      docs/router/config.json (1)

      625-632: Config entries correctly reference existing Solid Kitchen Sink + Solid Query example directories.

      Both examples/solid/kitchen-sink-solid-query-file-based/ and examples/solid/kitchen-sink-solid-query/ directories exist in the repository. The paths in config.json follow the established "framework/solid/examples/..." pattern used throughout the file (consistent with React examples). Naming convention is correct: file-based variant includes "-file-based" suffix, code-based variant does not. Placement and grouping logic is sound.


      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.
    2. View your CI Pipeline Execution ↗ for commit 4752b721d2478e93752d8a3ab5f6ec5ed3fbac06

      CommandStatusDurationResult
      nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded<1sView ↗
      nx run-many --target=build --exclude=examples/*...✅ Succeeded1sView ↗

      ☁️ Nx Cloud last updated this comment at 2025-10-21 13:25:59 UTC

    3. More templates

      @tanstack/arktype-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5563

      @tanstack/directive-functions-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5563

      @tanstack/eslint-plugin-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5563

      @tanstack/history

      npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5563

      @tanstack/nitro-v2-vite-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5563

      @tanstack/react-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5563

      @tanstack/react-router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5563

      @tanstack/react-router-ssr-query

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5563

      @tanstack/react-start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5563

      @tanstack/react-start-client

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5563

      @tanstack/react-start-server

      npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5563

      @tanstack/router-cli

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5563

      @tanstack/router-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5563

      @tanstack/router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5563

      @tanstack/router-devtools-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5563

      @tanstack/router-generator

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5563

      @tanstack/router-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5563

      @tanstack/router-ssr-query-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5563

      @tanstack/router-utils

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5563

      @tanstack/router-vite-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5563

      @tanstack/server-functions-plugin

      npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5563

      @tanstack/solid-router

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5563

      @tanstack/solid-router-devtools

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5563

      @tanstack/solid-router-ssr-query

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@5563

      @tanstack/solid-start

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5563

      @tanstack/solid-start-client

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5563

      @tanstack/solid-start-server

      npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5563

      @tanstack/start-client-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5563

      @tanstack/start-plugin-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5563

      @tanstack/start-server-core

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5563

      @tanstack/start-static-server-functions

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5563

      @tanstack/start-storage-context

      npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5563

      @tanstack/valibot-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5563

      @tanstack/virtual-file-routes

      npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5563

      @tanstack/zod-adapter

      npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5563

      commit: 4752b72

Sign in to join this conversation.