docs(router): restructure docs to use the unified markdown syntax#6665
docs(router): restructure docs to use the unified markdown syntax#6665SeanCassiere merged 12 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughThe PR restructures router documentation: it populates the Getting Started navigation, clears framework-specific children for React and Solid in docs/router/config.json, consolidates framework-specific content into shared pages with React/Solid sections, and removes or strips several Solid-specific doc files and cross-reference front-matter. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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 |
|
View your CI Pipeline Execution ↗ for commit 75a79ca
☁️ Nx Cloud last updated this comment at |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/router/quick-start.md (1)
58-60:⚠️ Potential issue | 🟡 Minor"existing React project" is also framework-specific in a now-generic page.
Line 60 still reads "If you have an existing React project and want to add TanStack Router to it…" — this should be broadened to match the framework-agnostic scope of the page, especially since the Requirements section immediately below already has framework-specific blocks for React and Solid.
✏️ Suggested fix
-If you have an existing React project and want to add TanStack Router to it, you can install it manually. +If you have an existing project and want to add TanStack Router to it, you can install it manually.
🤖 Fix all issues with AI agents
In `@docs/router/decisions-on-dx.md`:
- Around line 17-18: Fix the grammatical fragment in the tip block that starts
with "[!TIP]": replace the phrase "The examples in this guide where components
and code snippets are written in React" with a complete clause such as "The
examples in this guide, where components and code snippets are written in React,
..." or "The examples in this guide show components and code snippets written in
React..." and keep the rest of the sentence about Solid unchanged so the full
tip reads clearly and grammatically correct.
In `@docs/router/devtools.md`:
- Around line 274-289: The Solid example uses TanStackRouterDevtoolsPanel with
prop className but the DevtoolsPanel Options section documents the Solid prop as
class; update one to match the other for consistency. Edit the example or the
Options docs so both use the same prop name (either change the example to
class={class} or change the Options docs to document className for
TanStackRouterDevtoolsPanel) and ensure the referenced symbol
TanStackRouterDevtoolsPanel and example usage in the App function are updated
accordingly.
In `@docs/router/quick-start.md`:
- Line 25: The sentence "Once complete, a new React project will be generated
with TanStack Router installed and ready to use." is framework-specific; update
it to be framework-agnostic by replacing "React project" with a neutral phrase
such as "project" or "project for your chosen framework" (e.g., "Once complete,
a new project for your chosen framework will be generated with TanStack Router
installed and ready to use.") so the quick-start applies correctly to both React
and Solid scaffolding.
🧹 Nitpick comments (1)
docs/router/devtools.md (1)
245-245: Live example link is React-only.This link points to the React devtools panel example. Since the page now covers both frameworks, consider either noting that it's a React example or adding a Solid equivalent if one exists.
SeanCassiere
force-pushed
the
generic-documentation
branch
from
6fd9dcc to
214c8a6
Compare
SeanCassiere
changed the title
) * docs: move overview page * docs: move all top-level guides to use generic syntax * make comparison generic * apply coderabbit suggestions * docs: move installation guides * docs: move integrations * docs: move routing * docs: move router reference api * docs: move guides * docs: fixup links to guides from api reference * docs: other fixups * build(llms): LLM generation to account for doc structure change
1 participant
Requires TanStack/tanstack.com#716 to be merged at the same time.
The api reference docs are largely unchanged, which means it might have some React-isms which is fine for now, given that without this SolidJS users pretty didn't have these at all.
Summary by CodeRabbit