docs: add lit docs#327
Conversation
fredericbahr
force-pushed
the
docs-add-lit-adapter
branch
from
a4a83f2 to
463ffd3
Compare
|
No dependency changes detected. Learn more about Socket for GitHub. 👍 No dependency changes detected in pull request |
|
@KevinVandy or @crutchcorn could you perhaps have a look and approve this MR If you find Some spare time? Kind regards. |
|
View your CI Pipeline Execution ↗ for commit 0bcf28e
☁️ Nx Cloud last updated this comment at |
@tanstack/angular-store
@tanstack/lit-store
@tanstack/preact-store
@tanstack/react-store
@tanstack/solid-store
@tanstack/store
@tanstack/svelte-store
@tanstack/vue-store
commit: |
📝 WalkthroughWalkthroughLit is added as a supported framework across TanStack Store's documentation. The README and overview text are updated to include Lit, a new installation section for ChangesLit Framework Documentation and Config
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with 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.
Inline comments:
In `@docs/overview.md`:
- 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.
- 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e229a8a1-34e4-4612-a03a-b632411407bc
📒 Files selected for processing (5)
README.mddocs/config.jsondocs/installation.mddocs/overview.mdpackage.json
| --- | ||
|
|
||
| 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. |
There was a problem hiding this comment.
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.
| 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 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 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. No newline at end of file | ||
| 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. |
There was a problem hiding this comment.
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.
| 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
2 participants
The PR adds the following:
Summary by CodeRabbit
New Features
Documentation