Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migrate docs to use path-based navigation instead of route-based #7211

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

tannerlinsley
Copy link
Collaborator

TanStack Router uses path-based navigation instead of route-based navigation, so many of the relative documentation links will be invalid after migration. This fixes that.

TanStack Router uses path-based navigation instead of route-based navigation, so many of the relative documentation links will be invalid after migration. This fixes that.
Copy link

vercel bot commented Apr 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Updated (UTC)
query ⬜️ Ignored (Inspect) Apr 2, 2024 5:32am

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 2, 2024
@tannerlinsley tannerlinsley requested a review from TkDodo April 2, 2024 05:33
Copy link

nx-cloud bot commented Apr 2, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1b3e931. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@tannerlinsley
Copy link
Collaborator Author

I would appreciate any help to track down any other links that I may have missed.

Copy link

codesandbox-ci bot commented Apr 2, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 1b3e931:

Sandbox Source
@tanstack/query-example-angular-basic Configuration
@tanstack/query-example-react-basic-typescript Configuration
@tanstack/query-example-solid-basic-typescript Configuration
@tanstack/query-example-svelte-basic Configuration
@tanstack/query-example-vue-basic Configuration

@tannerlinsley tannerlinsley merged commit 754640a into main Apr 2, 2024
6 checks passed
@tannerlinsley tannerlinsley deleted the docs-migrate-tsr branch April 2, 2024 22:46
@douglasnaphas
Copy link

@tannerlinsley I'm not sure if this is related, but there are a lot docs pages linked from elsewhere in the docs that lead to a 404 page.

For example, this page

https://tanstack.com/query/latest/docs/framework/react/reference/useQuery

links to

https://tanstack.com/query/latest/docs/framework/react/reference/query-keys

which leads to a 404 page.

Screenshot 2024-04-07 at 10 35 44 PM
Screenshot 2024-04-07 at 10 36 02 PM

https://tanstack.com/query/latest/docs/framework/react/reference/useQuery also links to https://tanstack.com/query/latest/docs/framework/react/reference/default-query-function, which leads to a 404.

Informally, most links I've followed from React Query docs pages the past few days have led to 404s.

@kraenhansen
Copy link

@tannerlinsley I noticed the "Walkthough Guide" and "API Reference" links on the individual framework "overview" pages are broken: https://github.com/TanStack/query/blob/main/docs/framework/react/overview.md#you-talked-me-into-it-so-what-now .. this might be related to this change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants