docs(suspensive.org): add docs for cli #1032
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
@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."
There was a problem hiding this comment.
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.
gwansikk
changed the title
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. |
|
@gwansikk I'm fixing https://github.com/toss/suspensive/pull/1033/files pnpm error. Maybe this is about our error |
|
I fixed ci error now~! Let's go go |
CodSpeed Performance ReportMerging #1032 will create unknown performance changesComparing Summary
|
|
if this gets merged, I will attempt to request registration in the TanStack Query v5 Docs! with this: |
| @@ -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 was a problem hiding this comment.
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.
| "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" }, |
There was a problem hiding this comment.
Oh, I hadn't thought of that. Thank you!
Overview
I am adding a document introducing the Command-Line Interface (CLI).
Additionally, there are some parts we need to discuss together. Please make sure to check the comments below.
PR Checklist