toss / suspensive

Manage asynchronous operations, timing, error handling, detecting intersection of elements, and caching easily and declaratively
https://suspensive.org
MIT License
508 stars 48 forks source link

docs(suspensive.org): add docs for cli #1032

Closed gwansikk closed 3 months ago

gwansikk commented 3 months ago

Overview

I am adding a document introducing the Command-Line Interface (CLI).

support-both-tanstack-query-v4-and-5.en.mdx support-both-tanstack-query-v4-and-5.ko.mdx
image image

Additionally, there are some parts we need to discuss together. Please make sure to check the comments below.

PR Checklist

  1. I read the Contributing Guide
  2. I added documents and tests.
changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 86ec1959c4a77e2b3b261e44d7cbb66363b76a87

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

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2024 2:59pm
v1.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2024 2:59pm
visualization.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2024 2:59pm
manudeli commented 3 months ago
image

In my opinion, It would be better to title this document not as "CLI", just like as "Support both TanStack Query v4 and 5" and "TanStack Query v4, 5를 모두 지원"

I think that a title that focuses on the benefits the user will receive may be easier to click on. It would be better to intuitively expose the benefits to users without having to enter the page.

manudeli commented 3 months ago

@gwansikk I'm fixing https://github.com/toss/suspensive/pull/1033/files pnpm error.

Maybe this is about our error https://github.com/pnpm/action-setup/issues/136

manudeli commented 3 months ago

I fixed ci error now~! Let's go go

codspeed-hq[bot] commented 3 months ago

CodSpeed Performance Report

Merging #1032 will create unknown performance changes

Comparing docs/feature/how-to-use-cli (86ec195) with main (451ec67)

Summary

:warning: No benchmarks were detected in both the base of the PR and the PR.

gwansikk commented 3 months ago

if this gets merged, I will attempt to request registration in the TanStack Query v5 Docs!

with this: