Skip to content

fix(docs): polish homepage source pills and install guides#30

Merged
SutuSebastian merged 2 commits into
mainfrom
fix/docs-home-snippets-and-install
Jul 20, 2026
Merged

fix(docs): polish homepage source pills and install guides#30
SutuSebastian merged 2 commits into
mainfrom
fix/docs-home-snippets-and-install

Conversation

@SutuSebastian

@SutuSebastian SutuSebastian commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Hero source pills: real brand logos, Title Case labels, minimal equal snippets, InstallBox matches default pill
  • Guides: Blume package-install tabs; PersistableSource.subscribe returns { unsubscribe } in wrapping-stores + migrating examples

Test plan

  • Homepage pills show TanStack / Zustand bear / Jotai / Valtio / MobX marks
  • Switching pills updates code + install command
  • Getting started + idb-react show package-manager tabs
  • docs label present so Deploy docs runs on merge

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to use npm commands.
    • Revised migration and custom store examples to return unsubscribe objects.
    • Refreshed framework names, branding, and source code snippets.
  • Improvements
    • Updated the homepage source selector to use a shared default and display the matching installation command.
    • Improved the TanStack Store quick-start example with the current persistence setup.

Use real brand marks, level hero snippets, Blume package-install tabs, and fix PersistableSource subscribe shapes in docs examples.
@SutuSebastian SutuSebastian added the docs Public docs site (apps/docs) — merge deploys /persist via FTP label Jul 20, 2026
@changeset-bot

changeset-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a1fa21f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@SutuSebastian, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ec90124c-253f-4d80-8c82-508d5ba5f2ec

📥 Commits

Reviewing files that changed from the base of the PR and between abf2ee5 and a1fa21f.

📒 Files selected for processing (1)
  • apps/docs/content/guides/migrating.mdx
📝 Walkthrough

Walkthrough

The documentation updates centralize the homepage’s default source, revise source metadata and examples, align adapter subscriptions with unsubscribe objects, and replace Bun installation commands with npm commands.

Changes

Documentation source updates

Layer / File(s) Summary
Source catalog and examples
apps/docs/pages/_home/source-snippets.ts
Adds the shared default source, updates branding metadata, revises the TanStack Store example, and wraps custom subscriptions with an unsubscribe function.
Homepage source selection
apps/docs/pages/_home/Hero.astro, apps/docs/pages/_home/InstallBox.astro, apps/docs/pages/_home/Seams.astro
Uses the shared default source for active styling, initial code visibility, and installation command selection, and updates displayed source casing.
Adapter subscription contracts
apps/docs/content/guides/migrating.mdx, apps/docs/content/recipes/wrapping-stores.mdx
Updates migration and custom adapter examples to return objects containing unsubscribe functions.
npm installation instructions
apps/docs/content/guides/getting-started.mdx, apps/docs/content/guides/idb-react.mdx
Replaces Bun installation commands with npm commands and package-install blocks.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main docs UI and installation-guide polish, though it omits some subscribe-example updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-home-snippets-and-install

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Stay on zustand for the zustand-persist path, define the Pinia store, and use $patch for setState.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
apps/docs/pages/_home/Seams.astro (1)

19-22: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Align the label with the source snippet catalog.

In source-snippets.ts, the custom source label is configured as "Any source". Consider updating "custom source" here as well to ensure consistency across the UI.

🎨 Proposed optional tweak
   "Valtio",
   "MobX",
-  "custom source",
+  "Any source",
🤖 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 `@apps/docs/pages/_home/Seams.astro` around lines 19 - 22, Update the custom
source label in the Seams source list to “Any source” so it matches the label
configured in source-snippets.ts and remains consistent across the UI.
🤖 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.

Nitpick comments:
In `@apps/docs/pages/_home/Seams.astro`:
- Around line 19-22: Update the custom source label in the Seams source list to
“Any source” so it matches the label configured in source-snippets.ts and
remains consistent across the UI.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cd72c871-2f95-41d5-a22d-072ed7c717d2

📥 Commits

Reviewing files that changed from the base of the PR and between 1a4f458 and abf2ee5.

⛔ Files ignored due to path filters (5)
  • apps/docs/public/brands/jotai.png is excluded by !**/*.png
  • apps/docs/public/brands/mobx.svg is excluded by !**/*.svg
  • apps/docs/public/brands/tanstack.svg is excluded by !**/*.svg
  • apps/docs/public/brands/valtio.svg is excluded by !**/*.svg
  • apps/docs/public/brands/zustand.png is excluded by !**/*.png
📒 Files selected for processing (8)
  • apps/docs/content/guides/getting-started.mdx
  • apps/docs/content/guides/idb-react.mdx
  • apps/docs/content/guides/migrating.mdx
  • apps/docs/content/recipes/wrapping-stores.mdx
  • apps/docs/pages/_home/Hero.astro
  • apps/docs/pages/_home/InstallBox.astro
  • apps/docs/pages/_home/Seams.astro
  • apps/docs/pages/_home/source-snippets.ts

@SutuSebastian
SutuSebastian merged commit dae4537 into main Jul 20, 2026
12 of 13 checks passed
@SutuSebastian
SutuSebastian deleted the fix/docs-home-snippets-and-install branch July 20, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Public docs site (apps/docs) — merge deploys /persist via FTP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant