Skip to content

Conversation

@LadyBluenotes
Copy link
Contributor

@LadyBluenotes LadyBluenotes commented Oct 17, 2025

Summary by CodeRabbit

  • Documentation
    • Clarified Solid installation guide labels ("Vite" and "Router CLI") for improved navigation.
    • Reorganized documentation structure to better organize framework installation resources.

@github-actions github-actions bot added the documentation Everything documentation related label Oct 17, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 17, 2025

Walkthrough

Documentation structure reorganized for Solid framework installation guides. Configuration routing targets updated to reflect new installation directory structure, and front-matter references adjusted to point to updated React documentation paths.

Changes

Cohort / File(s) Summary
Configuration routing updates
docs/router/config.json
Two Solid installation guide entries renamed and rerouted: "Installation with Vite" → "Vite" (path: framework/solid/installation/with-vite), "Installation with the Router CLI" → "Router CLI" (path: framework/solid/installation/with-router-cli). Previous paths were under routing/installation-*.
Documentation front-matter references
docs/router/framework/solid/installation/with-vite.md, docs/router/framework/solid/installation/with-router-cli.md
Front-matter ref fields updated to point to React documentation under new installation/ directory structure (changed from routing/installation/ paths).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • TanStack/router#5443: Updates Solid installation navigation entries and reorganizes documentation into the new "Installation Guides" directory structure.
  • TanStack/router#5483: Adds React installation entries and updates docs-generation script to include the same React documentation paths referenced here.

Suggested reviewers

  • schiller-manuel
  • birkskyum

Poem

🐰 The docs hop to their new home today,
Installation guides find their proper way,
From routing's nest to installation's ground,
References align—no paths left unfound!
Order restored, clarity found at last,
Our documentation's future is vast! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "docs: fix solid installation guides" directly and accurately summarizes the main changes in this pull request. The changeset updates routing paths and renames two Solid installation guide entries in the configuration file and their corresponding documentation files. The title is clear, specific, and concise without being vague or using generic terms. It uses the standard "docs:" prefix convention and effectively communicates that the pull request is about fixing Solid installation documentation, which aligns with what a reviewer scanning the history would expect to find.
Docstring Coverage ✅ Passed No 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

📜 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 7978449 and 394df3b.

📒 Files selected for processing (3)
  • docs/router/config.json (1 hunks)
  • docs/router/framework/solid/installation/with-router-cli.md (1 hunks)
  • docs/router/framework/solid/installation/with-vite.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/router/framework/solid/installation/with-vite.md
  • docs/router/framework/solid/installation/with-router-cli.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

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

Files:

  • docs/router/framework/solid/installation/with-vite.md
  • docs/router/config.json
  • docs/router/framework/solid/installation/with-router-cli.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Preview
🔇 Additional comments (4)
docs/router/config.json (2)

126-131: Config structure and label changes look good.

The Solid installation entries have been properly reorganized to mirror the React structure, with labels simplified for consistency and routes updated to reflect the new directory structure under framework/solid/installation/. The changes align with the stated PR objective to fix the installation guide organization.


126-131: ✓ Solid installation guides verified and properly configured.

All markdown files exist at the configured paths, and old routing paths have been successfully cleaned up. The config entries at lines 126-131 correctly reference the new installation guide locations.

docs/router/framework/solid/installation/with-router-cli.md (1)

2-2: No issues found. The referenced React Router CLI guide exists at the updated path.

The verification confirms that docs/router/framework/react/installation/with-router-cli.md exists and the old path has been removed. The front matter reference is correct and points to a valid location.

docs/router/framework/solid/installation/with-vite.md (1)

2-2: Front matter reference verified and correct.

The referenced React installation guide exists at docs/router/framework/react/installation/with-vite.md, confirming the front matter ref has been properly updated to align with the new directory structure without the /routing/ segment.


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.

@nx-cloud
Copy link

nx-cloud bot commented Oct 17, 2025

View your CI Pipeline Execution ↗ for commit 394df3b

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-17 21:27:28 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 17, 2025

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: 394df3b

@schiller-manuel schiller-manuel merged commit 42e795d into TanStack:main Oct 17, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants