Commit graph

7 commits

Author SHA1 Message Date
Alem Tuzlak
9bf08e270f
docs: comprehensive documentation overhaul (#363)
* docs: add documentation redesign design document

Comprehensive plan for restructuring TanStack Devtools documentation
with layered architecture approach: Getting Started, Concepts, Guides,
API Reference, and Examples sections. Adds 11 new pages including
architecture overview, event system deep-dive, Vue framework support,
and plugin building guides.

* docs: add documentation implementation plan

18-task plan covering: navigation restructure, 4 new Concepts pages
(architecture, event system, plugin lifecycle, source inspector),
3 new Guides (custom plugins, devtools-utils, bidirectional comms),
Vue framework support, Solid custom plugins, and updates to existing
pages including overview, quick-start, installation, and React adapter.

* docs: restructure navigation with Concepts and Guides sections, add Vue

* docs: expand overview with package map and architecture diagram

* docs: add all framework examples to quick start

* docs: add Vue and Preact installation instructions

* docs: add architecture overview page

* docs: add event system concepts page

* docs: add plugin lifecycle concepts page

* docs: add source inspector concepts page

* docs: add framework-agnostic custom plugin building guide

* docs: add devtools-utils guide for plugin factory helpers

* docs: add bidirectional communication guide

* docs: add Vue basic setup and adapter pages

* docs: add Vue and Solid custom plugins guides

* docs: replace TODO in React adapter with actual content

* docs: expand Vite plugin features documentation

* docs: fix event map key convention, typos, and internal link extensions

- Event map keys should be suffix-only (e.g., 'state-update'), not
  prefixed with pluginId. EventClient prepends pluginId automatically.
  Fixed across all custom plugin guides and concept pages.
- Fix enabled:false docs in event-system.md (emit is a no-op, not
  internal dispatch)
- Fix double "the the" typo in installation.md
- Remove .md extensions from internal doc links for consistency
- Fix event map key in configuration.md example

* docs: remove internal plan files

* docs: replace ASCII diagrams with mermaid in architecture overview

* docs: add mermaid diagrams across all documentation pages

- overview.md: architecture layer diagram
- event-system.md: connection lifecycle state diagram
- plugin-lifecycle.md: mount sequence flowchart + portal pattern diagram
- source-inspector.md: inspection flow diagram
- building-custom-plugins.md: plugin architecture overview
- bidirectional-communication.md: two-way flow + time travel sequence diagram
- vite-plugin.md: sub-plugin overview diagram
2026-03-04 13:52:26 +01:00
Lachlan Collins
66722f5a70
docs: correct local relative links (#282)
* docs: correct local relative links

* Fix config imports
2025-12-05 22:38:56 +11:00
TakhyunKim
fadd95541d
docs: unify code conventions in example code within document (#156)
Fixes #155 

### Changes

Remove unused commas, semicolons, and spaces.
Also fix the incorrect constructor depth.
2025-09-22 12:51:15 +02:00
TakhyunKim
19a92cf5d3
fix: update broken links in documents (#141)
I'm delighted to be able to contribute to such a great project. Thank
you.

### Changes

Releated issue: https://github.com/TanStack/devtools/issues/140

Resolves the issue where some links in the [TanStack Devtools
documentation](https://tanstack.com/devtools/latest/docs/overview) were
broken.

Testing for the updated link was conducted by referring to the README at
tanstack.com below.
- https://github.com/TanStack/tanstack.com/blob/main/README.md
2025-09-18 19:19:34 +02:00
Matthijs Kok
44a8410b47
chore: capitalize "TanStack" consistently (#35) 2025-08-14 11:47:20 +02:00
Harry Whorlow
22631ae155 chore: minor changes 2025-08-10 11:56:34 +02:00
Harry Whorlow
55ae3b86e4 chore: pr comments and tweeks 2025-08-10 11:56:34 +02:00