Merge pull request #1183 from Shopify/add_link_to_typing_guide

Add links to the GQL types guide
Shopify · Jan 31, 2024 · ea7e267 · ea7e267
2 parents 19c5c14 + 70d2e2f
commit ea7e267
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/.changeset/afraid-flies-end.md b/.changeset/afraid-flies-end.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/shopify-api/CHANGELOG.md b/packages/shopify-api/CHANGELOG.md
@@ -32,7 +32,7 @@
 
   With this change, we can return a `Response` object for requests with the upcoming clients, which can help make the interface for requests more familiar to users.
 
-  For more information and examples, see the [migration guide to v9](https://github.com/Shopify/shopify-api-js/blob/main/packages/shopify-api/docs/migrating-to-v9.md#changes-to-runtime-adapters).
+  For more information and examples, see the [migration guide to v9](./docs/migrating-to-v9.md#changes-to-runtime-adapters).
 
 - 7bd4be08: Rephrased `gdprTopics` to `privacyTopics` to account for other privacy regulations with data subject requests.
 
@@ -56,7 +56,7 @@
 - 83b15905: Allow access tokens to be marked as expired before actual expiry.
 - 218f4521: Use the new GraphQL API clients in shopify-api to use all of the latest features, including automatic types for query / mutation return object and variables.
 
-  For more information and examples, see the [migration guide to v9](https://github.com/Shopify/shopify-api-js/blob/main/packages/shopify-api/docs/migrating-to-v9.md#using-the-new-clients).
+  For more information and examples, see the [migration guide to v9](./docs/migrating-to-v9.md#using-the-new-clients).
 
 - 18781092: Updated shopify-api GraphQL clients' APIs to be closer to the underlying clients
 - 4dd7612d: Underpinned the new REST client from `admin-api-client` into `shopify-api`, so apps can access it as a standalone client as well.

diff --git a/packages/shopify-api/README.md b/packages/shopify-api/README.md
@@ -111,6 +111,7 @@ To do that, apps will need to:
 - [Storing sessions](docs/guides/session-storage.md)
 - [Setting up webhooks](docs/guides/webhooks.md)
 - [Using REST resources](docs/guides/rest-resources.md)
+- [Using GraphQL types](docs/guides/graphql-types.md)
 - [Configuring Billing](docs/guides/billing.md)
 - [Adding custom runtimes](docs/guides/runtimes.md)
 - [Customizing logging configuration](docs/guides/logger.md)

diff --git a/packages/shopify-api/docs/migrating-to-v9.md b/packages/shopify-api/docs/migrating-to-v9.md
@@ -114,6 +114,9 @@ setAbstractFetchFunc(convertFetch);
 
 With the introduction of the new clients, we've deprecated the `query` method in favor of `request`.
 
+One of the main improvements we made in the new clients is the ability to type GraphQL operations using TypeScript types.
+To start using types in your app, you can follow the [GraphQL types guide](./guides/graphql-types.md).
+
 `request` takes in the query / mutation as the first argument, and the following options:
 
 | Old option          | New option  | Notes                                                                                  |