store icon indicating copy to clipboard operation
store copied to clipboard
verified publisher icon TanStack

Docs: Quick start and useStore API reference page for react are broken

Open sadik-malik opened this issue 2 years ago • 5 comments

Describe the bug

  1. Quick start page for react is not opening, the page is stuck on displaying infinite spinning loader.
  2. Codesandbox link for react example of useStore is not found.

Your Example Website or App

https://tanstack.com/store/latest/docs/framework/react/reference/useStore

Steps to Reproduce the Bug or Issue

Refer the image for both the problems. I have first opened the useStore react example and then clicked on Quick start for react. You can see both not found error and infinite spinning loader in the image.

Expected behavior

  1. When clicked on quick start for react, the page display documentation on how to use TanStack Store in react instead of infinite spinning loader.
  2. Codesandbox example should display Tanstack Store usage in react instead of 404 error.

Screenshots or Videos

image

Platform

  • OS: Windows
  • Browser: Chrome
  • Version: 120.0.6099.72 (Official Build) (64-bit)

Additional context

No response

sadik-malik avatar Dec 16 '23 17:12 sadik-malik

This is my bad. This was my first TanStack project I launched and I didn't have any examples in the repo to support this. I'll add some examples early next year

crutchcorn avatar Dec 31 '23 11:12 crutchcorn

Until this is resolved it looks like https://github.com/TanStack/store/blob/main/docs/framework/react/quick-start.md is the correct file.

ImLunaHey avatar Jan 10 '24 01:01 ImLunaHey

Thank you @ImLunaHey

Until this is resolved it looks like https://github.com/TanStack/store/blob/main/docs/framework/react/quick-start.md is the correct file.

sadik-malik avatar Jan 10 '24 07:01 sadik-malik

Hello, @sadik-malik . Has the issue of not adding examples been resolved yet? I can't find examples in the docs and codebox. I'm curious and looking forward to seeing what tanstack/store does :)

https://tanstack.com/store/latest/docs/framework/react/examples/simple

https://github.com/TanStack/store/assets/80191860/33a9a4dc-f31d-4c99-8743-2ac3bc7b4687

yoosion030 avatar Mar 12 '24 01:03 yoosion030

@yoosion030 the issue is not fixed. You can refer to the quick start guide.

https://github.com/TanStack/store/blob/main/docs/framework/react/quick-start.md

sadik-malik avatar Mar 12 '24 04:03 sadik-malik

This is now fixed alongside a few improvements, namely:

  • Reference docs are auto-generated from the code (so they cannot get outdated)
  • Examples in all supported frameworks are now live

crutchcorn avatar Nov 25 '24 13:11 crutchcorn