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

gwansikk · 2024-07-04T11:01:47Z

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

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

PR Checklist

I did below actions if need

I read the Contributing Guide
I added documents and tests.

changeset-bot · 2024-07-04T11:01:50Z

⚠️ No Changeset found

Latest commit: 86ec195

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 · 2024-07-04T11:01:50Z

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

docs/suspensive.org/src/pages/docs/react-query/_meta.en.json

gwansikk · 2024-07-04T11:10:38Z

docs/suspensive.org/src/pages/docs/react-query/command-line-interface.en.mdx

+
+Starting from version 2.2.0, @suspensive/react-query supports both versions 4 and 5 of @tanstack/react-query.
+
+Internally, it consists of @suspensive/react-query-4 and @suspensive/react-query-5, which correspond to the respective versions of @tanstack/react-query. (In this document, these version-specific packages are referred to as modules.) The CLI automatically detects the installed version of @tanstack/react-query in your environment and uses the compatible version.


We need to discuss this part. Since version 2.2.0, @suspensive/react-query has been internally switching between @suspensive/react-query-4 and @suspensive/react-query-5. To make it easier for users to understand, I have referred to this as “modules” in the document. I thought it would be confusing to call them versions 4 or 5 of @suspensive/react-query, as it might be mistaken for the actual package versions.

I think “modules” or “adapters” would be good terms. Do you have any better ideas?

@manudeli What do you think about this opinion? I'm concerned that calling @suspensive/react-query-4 and @suspensive/react-query-5 "versions" in the documentation might cause confusion with the actual @suspensive/react-query package versions. I think it would be better to refer to them as "modules" or "adapters."

I agree with you. Rather than entering the version number, I think it would be simpler to understand by expressing it as follows.

Automatically changes Suspensive’s interface according to the version of @tanstack/react-query.

manudeli · 2024-07-04T11:34:35Z

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 · 2024-07-04T11:55:49Z

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

Maybe this is about our error
pnpm/action-setup#136

manudeli · 2024-07-04T11:59:09Z

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

codspeed-hq · 2024-07-04T11:59:57Z

CodSpeed Performance Report

Merging #1032 will create unknown performance changes

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

Summary

⚠️ No benchmarks were detected in both the base of the PR and the PR.

gwansikk · 2024-07-04T14:21:50Z

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

with this:

[Feature]: update Suspensive React Query section in TanStack Query v4 official doc #956

manudeli · 2024-07-04T14:33:55Z

docs/suspensive.org/src/pages/docs/react-query/_meta.en.json

@@ -1,7 +1,7 @@
 {
  "motivation": { "title": "Why need to use?" },
  "installation": { "title": "Installation" },
-  "command-line-interface": { "title": "Command-Line Interface" },
+  "support-both-tanstack-query-v4-and-5": { "title": "Support both TanStack Query v4 and 5" },


There may be a time in the future to support v6, so I hope it is an expandable path name.
I think it's a good idea for links not to change frequently

For example, when adding this link to a user's blog, I would like to prevent the user from being unable to enter if the link changes.

Suggested change

"support-both-tanstack-query-v4-and-5": { "title": "Support both TanStack Query v4 and 5" },

"tanstack-query-compatibility": { "title": "Support both TanStack Query v4 and 5" },

Oh, I hadn't thought of that. Thank you!

docs/suspensive.org/src/pages/docs/react-query/_meta.ko.json

manudeli

Coool! So much better experience to use cli

# 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](https://github.com/toss/suspensive/assets/39869096/fb03b973-0c8f-4f9c-9e9c-cf8395216e2d)|![image](https://github.com/toss/suspensive/assets/39869096/cb86da0d-a16d-418b-89e3-7c82fbab722f)| Additionally, there are some parts we need to discuss together. Please make sure to check the comments below. ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md) 2. I added documents and tests. --------- Co-authored-by: Jonghyeon Ko <[email protected]>

# 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](https://github.com/toss/suspensive/assets/39869096/fb03b973-0c8f-4f9c-9e9c-cf8395216e2d)|![image](https://github.com/toss/suspensive/assets/39869096/cb86da0d-a16d-418b-89e3-7c82fbab722f)| Additionally, there are some parts we need to discuss together. Please make sure to check the comments below. ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md) 2. I added documents and tests. ---------

# 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](https://github.com/toss/suspensive/assets/39869096/fb03b973-0c8f-4f9c-9e9c-cf8395216e2d)|![image](https://github.com/toss/suspensive/assets/39869096/cb86da0d-a16d-418b-89e3-7c82fbab722f)| Additionally, there are some parts we need to discuss together. Please make sure to check the comments below. ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md) 2. I added documents and tests. --------- Co-authored-by: Jonghyeon Ko <[email protected]>

docs(react-query): add docs for cli

b3a8283

gwansikk self-assigned this Jul 4, 2024

gwansikk linked an issue Jul 4, 2024 that may be closed by this pull request

[Feature]: How to use cli in https://suspensive.org #983

Closed

github-actions bot added the suspensive.org label Jul 4, 2024

gwansikk commented Jul 4, 2024

View reviewed changes

docs/suspensive.org/src/pages/docs/react-query/_meta.en.json Outdated Show resolved Hide resolved

gwansikk commented Jul 4, 2024

View reviewed changes

gwansikk changed the title ~~docs(react-query): add docs for cli~~ docs(suspensive.org): add docs for cli Jul 4, 2024

gwansikk marked this pull request as ready for review July 4, 2024 11:20

gwansikk requested a review from manudeli as a code owner July 4, 2024 11:20

Merge branch 'main' into docs/feature/how-to-use-cli

a88949b

vercel bot deployed to Preview – visualization.suspensive.org July 4, 2024 11:52 View deployment

vercel bot deployed to Preview – v1.suspensive.org July 4, 2024 11:54 View deployment

vercel bot deployed to Preview – suspensive.org July 4, 2024 11:54 View deployment

Merge branch 'main' into docs/feature/how-to-use-cli

3f5339f

vercel bot deployed to Preview – v1.suspensive.org July 4, 2024 12:02 View deployment

vercel bot deployed to Preview – visualization.suspensive.org July 4, 2024 12:02 View deployment

vercel bot deployed to Preview – suspensive.org July 4, 2024 12:03 View deployment

docs(suspensive.org): update docs for cli

129dcc0

vercel bot deployed to Preview – v1.suspensive.org July 4, 2024 14:12 View deployment

vercel bot deployed to Preview – visualization.suspensive.org July 4, 2024 14:12 View deployment

vercel bot deployed to Preview – suspensive.org July 4, 2024 14:13 View deployment

manudeli requested changes Jul 4, 2024

View reviewed changes

docs(suspensive.org): update docs for cli

86ec195

vercel bot deployed to Preview – suspensive.org July 4, 2024 14:58 View deployment

vercel bot deployed to Preview – visualization.suspensive.org July 4, 2024 14:58 View deployment

vercel bot deployed to Preview – v1.suspensive.org July 4, 2024 14:59 View deployment

gwansikk requested a review from manudeli July 4, 2024 14:59

manudeli approved these changes Jul 4, 2024

View reviewed changes

manudeli merged commit 51671ca into main Jul 4, 2024
16 checks passed

manudeli deleted the docs/feature/how-to-use-cli branch July 4, 2024 15:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

gwansikk commented Jul 4, 2024 •

edited

Loading

changeset-bot bot commented Jul 4, 2024 •

edited

Loading

vercel bot commented Jul 4, 2024 •

edited

Loading

gwansikk Jul 4, 2024

gwansikk Jul 4, 2024

manudeli Jul 4, 2024

manudeli commented Jul 4, 2024 •

edited

Loading

manudeli commented Jul 4, 2024 •

edited

Loading

manudeli commented Jul 4, 2024

codspeed-hq bot commented Jul 4, 2024 •

edited

Loading

gwansikk commented Jul 4, 2024

manudeli Jul 4, 2024

gwansikk Jul 4, 2024

manudeli left a comment


		Starting from version 2.2.0, @suspensive/react-query supports both versions 4 and 5 of @tanstack/react-query.

		Internally, it consists of @suspensive/react-query-4 and @suspensive/react-query-5, which correspond to the respective versions of @tanstack/react-query. (In this document, these version-specific packages are referred to as modules.) The CLI automatically detects the installed version of @tanstack/react-query in your environment and uses the compatible version.

	"support-both-tanstack-query-v4-and-5": { "title": "Support both TanStack Query v4 and 5" },
	"tanstack-query-compatibility": { "title": "Support both TanStack Query v4 and 5" },

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

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

Conversation

gwansikk commented Jul 4, 2024 • edited Loading

Overview

PR Checklist

changeset-bot bot commented Jul 4, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Jul 4, 2024 • edited Loading

gwansikk Jul 4, 2024

Choose a reason for hiding this comment

gwansikk Jul 4, 2024

Choose a reason for hiding this comment

manudeli Jul 4, 2024

Choose a reason for hiding this comment

manudeli commented Jul 4, 2024 • edited Loading

manudeli commented Jul 4, 2024 • edited Loading

manudeli commented Jul 4, 2024

codspeed-hq bot commented Jul 4, 2024 • edited Loading

CodSpeed Performance Report

Merging #1032 will create unknown performance changes

Summary

gwansikk commented Jul 4, 2024

manudeli Jul 4, 2024

Choose a reason for hiding this comment

gwansikk Jul 4, 2024

Choose a reason for hiding this comment

manudeli left a comment

Choose a reason for hiding this comment

gwansikk commented Jul 4, 2024 •

edited

Loading

changeset-bot bot commented Jul 4, 2024 •

edited

Loading

vercel bot commented Jul 4, 2024 •

edited

Loading

manudeli commented Jul 4, 2024 •

edited

Loading

manudeli commented Jul 4, 2024 •

edited

Loading

codspeed-hq bot commented Jul 4, 2024 •

edited

Loading