Skip to content

Commit fd892b3

Browse files
docs(webapp): document the Query devtools flag in the README
The opt-in was only discoverable by grepping AppProviders.tsx, which excludes anyone who doesn't already know the devtools exist. The README now names the flag next to the rest of the webapp's dev setup, and says why the tool is off by default. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a2ab404 commit fd892b3

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

standalone/webapp/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,24 @@ Part of the Apollon monorepo — run it from the repo root with `pnpm dev`, not
66

77
## Stack
88

9-
React 19, TypeScript, Vite, the shadcn-style [`@tumaet/ui`](../../packages/ui) design system (Base UI primitives + Tailwind v4), Storybook, Vitest, Playwright (visual + e2e).
9+
React 19, TypeScript, Vite, the shadcn-style [`@tumaet/ui`](../../packages/ui) design system (Base UI primitives + Tailwind v4), [TanStack Query](https://tanstack.com/query) for server state, Storybook, Vitest, Playwright (visual + e2e).
10+
11+
## Debugging server state
12+
13+
HTTP data (diagram loads, version history, version snapshots) goes through
14+
TanStack Query — see [`src/queries`](src/queries) and the boundary note in
15+
[`src/queryClient.ts`](src/queryClient.ts).
16+
17+
The Query Devtools are **off by default**: their floating button sits
18+
bottom-right, on top of the editor's minimap, and every other corner is taken
19+
by the editor's own chrome. Enable them per browser from the console, then
20+
reload:
21+
22+
```js
23+
localStorage.setItem("apollon:query-devtools", "1")
24+
```
25+
26+
They are stripped from production builds regardless.
1027

1128
## Scripts
1229

0 commit comments

Comments
 (0)