Skip to content

Commit 812abbe

Browse files
committed
Modernize README to be more aligned with other tanstack READMEs
1 parent ddf54a5 commit 812abbe

File tree

1 file changed

+52
-38
lines changed

1 file changed

+52
-38
lines changed

README.md

Lines changed: 52 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# Welcome to TanStack.com!
1+
<div align="center">
22

3-
This site is built with TanStack Router!
3+
# TanStack.com
44

5-
- [TanStack Router Docs](https://tanstack.com/router)
5+
The home of the TanStack ecosystem. Built with [TanStack Router](https://tanstack.com/router) and deployed automagically with [Netlify](https://netlify.com/).
66

7-
It's deployed automagically with Netlify!
7+
<a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/></a>
88

9-
- [Netlify](https://netlify.com/)
9+
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
10+
11+
</div>
1012

1113
## Development
1214

@@ -19,54 +21,66 @@ pnpm dev
1921

2022
This starts your app in development mode, rebuilding assets on file changes.
2123

22-
## Editing and previewing the docs of TanStack projects locally
24+
## Local Setup for Docs & Commits
2325

24-
The documentations for all TanStack projects except for `React Charts` are hosted on [https://tanstack.com](https://tanstack.com), powered by this TanStack Router app.
25-
In production, the markdown doc pages are fetched from the GitHub repos of the projects, but in development they are read from the local file system.
26+
The documentation for all TanStack projects (except `React Charts`) is hosted on [tanstack.com](https://tanstack.com). In production, doc pages are fetched from GitHub. In development, they're read from your local file system.
2627

27-
Follow these steps if you want to edit the doc pages of a project (in these steps we'll assume it's [`TanStack/form`](https://github.com/tanstack/form)) and preview them locally :
28+
Pre-commit hooks run smoke tests against these docs, so you'll need sibling repos cloned for commits to pass.
2829

29-
1. Create a new directory called `tanstack`.
30+
Create a `tanstack` parent directory and clone this repo alongside the projects:
3031

3132
```sh
32-
mkdir tanstack
33+
mkdir tanstack && cd tanstack
34+
git clone git@github.com:TanStack/tanstack.com.git
35+
git clone git@github.com:TanStack/query.git
36+
git clone git@github.com:TanStack/router.git
37+
git clone git@github.com:TanStack/table.git
3338
```
3439

35-
2. Enter the directory and clone this repo and the repo of the project there.
40+
Your directory structure should look like this:
3641

37-
```sh
38-
cd tanstack
39-
git clone git@github.com:TanStack/tanstack.com.git
40-
git clone git@github.com:TanStack/form.git
4142
```
43+
tanstack/
44+
├── tanstack.com/
45+
├── query/
46+
├── router/
47+
└── table/
48+
```
49+
50+
> [!WARNING]
51+
> Directory names must match repo names exactly (e.g., `query` not `tanstack-query`). The app finds docs by looking for sibling directories by name.
52+
53+
## Editing Docs
54+
55+
To edit docs for a project, make changes in its `docs/` folder (e.g., `../form/docs/`) and visit http://localhost:3000/form/latest/docs/overview to preview.
4256

4357
> [!NOTE]
44-
> Your `tanstack` directory should look like this:
45-
>
46-
> ```
47-
> tanstack/
48-
> |
49-
> +-- form/
50-
> |
51-
> +-- tanstack.com/
52-
> ```
58+
> Updated pages need to be manually reloaded in the browser.
5359
5460
> [!WARNING]
55-
> Make sure the name of the directory in your local file system matches the name of the project's repo. For example, `tanstack/form` must be cloned into `form` (this is the default) instead of `some-other-name`, because that way, the doc pages won't be found.
61+
> Update the project's `docs/config.json` if you add a new doc page!
5662
57-
3. Enter the `tanstack/tanstack.com` directory, install the dependencies and run the app in dev mode:
63+
## Get Involved
5864

59-
```sh
60-
cd tanstack.com
61-
pnpm i
62-
# The app will run on https://localhost:3000 by default
63-
pnpm dev
64-
```
65+
- We welcome issues and pull requests!
66+
- Participate in [GitHub Discussions](https://github.com/TanStack/tanstack.com/discussions)
67+
- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
6568

66-
4. Now you can visit http://localhost:3000/form/latest/docs/overview in the browser and see the changes you make in `tanstack/form/docs`.
69+
## Explore the TanStack Ecosystem
6770

68-
> [!NOTE]
69-
> The updated pages need to be manually reloaded in the browser.
71+
- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
72+
- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
73+
- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
74+
- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
75+
- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching
76+
- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
77+
- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
78+
- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
79+
- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
80+
- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
81+
- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
82+
- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
7083

71-
> [!WARNING]
72-
> You will need to update the `docs/config.json` file (in the project's repo) if you add a new doc page!
84+
… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
85+
86+
<!-- Use the force, Luke -->

0 commit comments

Comments
 (0)