Skip to content

docs: add lit docs #327

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.

Sign up for GitHub

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

Merged
KevinVandy merged 3 commits into from
Jun 18, 2026
+20 −11
Merged

docs: add lit docs #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
463ffd3
docs: add lit docs
fredericbahr May 13, 2026
0bcf28e
Merge branch 'main' into docs-add-lit-adapter
KevinVandy Jun 18, 2026
bcb87b3
ci: apply automated fixes and generate docs
autofix-ci[bot] Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ An immutable, reactive data store with framework adapters that powers the core o

- Fine‑grained updates for performant state management
- Flexible primitives for building custom state logic
- Works across frameworks like React, Solid, Vue, Angular & Svelte
- Works across frameworks like React, Solid, Vue, Angular, Svelte & Lit
- Lightweight and standalone — use it in any app or as a library foundation

### <a href="https://tanstack.com/store">Read the docs →</b></a>
Expand Down
14 changes: 7 additions & 7 deletions docs/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"label": "react",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - React",
"to": "framework/react/quick-start"
}
]
Expand All @@ -36,7 +36,7 @@
"label": "vue",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Vue",
"to": "framework/vue/quick-start"
}
]
Expand All @@ -45,7 +45,7 @@
"label": "solid",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Solid",
"to": "framework/solid/quick-start"
}
]
Expand All @@ -54,7 +54,7 @@
"label": "angular",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Angular",
"to": "framework/angular/quick-start"
}
]
Expand All @@ -63,7 +63,7 @@
"label": "svelte",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Svelte",
"to": "framework/svelte/quick-start"
}
]
Expand All @@ -72,7 +72,7 @@
"label": "preact",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Preact",
"to": "framework/preact/quick-start"
}
]
Expand All @@ -81,7 +81,7 @@
"label": "lit",
"children": [
{
"label": "Quick Start",
"label": "Quick Start - Lit",
"to": "framework/lit/quick-start"
}
]
Expand Down
8 changes: 8 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,11 @@ npm install @tanstack/svelte-store
```

TanStack Store is compatible with Svelte 5.

## Lit

```sh
npm install @tanstack/lit-store
```

TanStack Store is compatible with Lit 3.
4 changes: 2 additions & 2 deletions docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ title: Overview
id: overview
---

TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

@coderabbitai coderabbitai Bot Jun 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix hyphenation in compound adjectives.

Lines 6 and 8 use unhyphenated compound adjectives that should be hyphenated per standard English grammar rules. Specifically: "framework agnostic" → "framework-agnostic" and "framework specific" → "framework-specific".

✏️ Proposed fix 
-TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.
+TanStack Store is a framework-agnostic data store that ships with framework-specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.
TanStack Store is a framework-agnostic data store that ships with framework-specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.
🧰 Tools
🪛 LanguageTool

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...rview --- TanStack Store is a framework agnostic data store that ships with fram...

(QB_NEW_EN_HYPHEN)

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...tic data store that ships with framework specific adapters for major frameworks l...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/overview.md` at line 6, In the overview.md file, hyphenate the compound
adjectives to follow standard English grammar rules. Change "framework agnostic"
to "framework-agnostic" in the description of TanStack Store, and change
"framework specific" to "framework-specific" where it refers to the adapters.
Both instances appear in the introductory section and should be updated to
properly hyphenate these compound modifiers that precede their nouns.

Source: Linters/SAST tools


TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.

@coderabbitai coderabbitai Bot Jun 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix hyphenation in compound adjective on line 8.

"framework agnostic" should be hyphenated as "framework-agnostic".

✏️ Proposed fix 
-TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
+TanStack Store is primarily used for state management internally for most framework-agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
TanStack Store is primarily used for state management internally for most framework-agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
🧰 Tools
🪛 LanguageTool

[grammar] ~8-~8: Use a hyphen to join words.
Context: ...management internally for most framework agnostic TanStack libraries. It can also...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/overview.md` at line 8, In the overview.md file, locate the phrase
"framework agnostic" in the line describing TanStack Store's usage. Since this
is a compound adjective modifying "TanStack libraries", it needs to be
hyphenated. Replace "framework agnostic" with "framework-agnostic" to follow
proper punctuation conventions for compound adjectives.

Source: Linters/SAST tools

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@
"@tanstack/solid-store": "workspace:*",
"@tanstack/store": "workspace:*",
"@tanstack/svelte-store": "workspace:*",
"@tanstack/vue-store": "workspace:*"
"@tanstack/vue-store": "workspace:*",
"@tanstack/lit-store": "workspace:*"
},
"pnpm": {
"packageExtensions": {
Expand Down
Loading