Skip to content

Commit

Permalink
Fix 2023-10 links (#1471)
Browse files Browse the repository at this point in the history
* Fix 2023-10 links

* Update packages/hydrogen/src/customer/customer.doc.ts

* Update packages/hydrogen-react/src/codegen.helpers.ts
  • Loading branch information
blittle committed Oct 31, 2023
1 parent 8198c1b commit 2ff057d
Show file tree
Hide file tree
Showing 11 changed files with 84 additions and 169 deletions.
193 changes: 54 additions & 139 deletions packages/hydrogen-react/docs/generated/generated_docs_data.json

Large diffs are not rendered by default.

Expand Up @@ -68,7 +68,7 @@
"type": "Generic",
"anchorLink": "versioning",
"title": "Versioning",
"sectionContent": "Hydrogen React is tied to specific versions of the [Storefront API](/docs/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-07`, then Hydrogen versions `2023.4.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen React version will include the same breaking changes.",
"sectionContent": "Hydrogen React is tied to specific versions of the [Storefront API](/docs/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-10`, then Hydrogen versions `2023.10.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen React version will include the same breaking changes.",
"sectionCard": [
{
"subtitle": "Learn more",
Expand Down
Expand Up @@ -75,7 +75,7 @@ const data: LandingTemplateSchema = {
anchorLink: 'versioning',
title: 'Versioning',
sectionContent:
"Hydrogen React is tied to specific versions of the [Storefront API](/docs/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-07`, then Hydrogen versions `2023.4.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen React version will include the same breaking changes.",
"Hydrogen React is tied to specific versions of the [Storefront API](/docs/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-10`, then Hydrogen versions `2023.10.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen React version will include the same breaking changes.",
sectionCard: [
{
subtitle: 'Learn more',
Expand Down
2 changes: 1 addition & 1 deletion packages/hydrogen-react/src/codegen.helpers.ts
@@ -1,6 +1,6 @@
/**
* Meant to be used with GraphQL CodeGen to type the Storefront API's custom scalars correctly.
* Reference for the GraphQL types: https://shopify.dev/docs/api/storefront/2023-07/scalars/HTML
* Reference for the GraphQL types: https://shopify.dev/docs/api/storefront/current/scalars/HTML
* Note: JSON is generated as 'unknown' by default.
*/
export const storefrontApiCustomScalars = {
Expand Down
38 changes: 19 additions & 19 deletions packages/hydrogen/docs/generated/generated_docs_data.json

Large diffs are not rendered by default.

Expand Up @@ -69,7 +69,7 @@
"type": "Generic",
"anchorLink": "versioning",
"title": "Versioning",
"sectionContent": "Hydrogen is tied to specific versions of the [Storefront API](/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-07`, then Hydrogen versions `2023.7.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen version will include the same breaking changes.",
"sectionContent": "Hydrogen is tied to specific versions of the [Storefront API](/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-10`, then Hydrogen versions `2023.10.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen version will include the same breaking changes.",
"sectionCard": [
{
"subtitle": "Learn more",
Expand Down
2 changes: 1 addition & 1 deletion packages/hydrogen/docs/staticPages/hydrogen.doc.ts
Expand Up @@ -76,7 +76,7 @@ const data: LandingTemplateSchema = {
anchorLink: 'versioning',
title: 'Versioning',
sectionContent:
"Hydrogen is tied to specific versions of the [Storefront API](/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-07`, then Hydrogen versions `2023.7.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen version will include the same breaking changes.",
"Hydrogen is tied to specific versions of the [Storefront API](/api/storefront), which is versioned quarterly. For example, if you're using Storefront API version `2023-10`, then Hydrogen versions `2023.10.x` are fully compatible.\n\n> Caution:\n>If a Storefront API version includes breaking changes, then the corresponding Hydrogen version will include the same breaking changes.",
sectionCard: [
{
subtitle: 'Learn more',
Expand Down
2 changes: 1 addition & 1 deletion packages/hydrogen/src/customer/customer.doc.ts
Expand Up @@ -8,7 +8,7 @@ const data: ReferenceEntityTemplateSchema = {
{
name: 'createStorefrontClient',
type: 'utility',
url: '/docs/api/hydrogen/2023-07/utilities/createstorefrontclient',
url: '/docs/api/hydrogen/current/utilities/createstorefrontclient',
},
],
description: `> Caution:
Expand Down
4 changes: 2 additions & 2 deletions templates/demo-store/app/components/FeaturedProducts.tsx
Expand Up @@ -26,8 +26,8 @@ interface FeaturedProductsProps {
* @param query a filtering query
* @param reverse wether to reverse the product results
* @param sortKey Sort the underlying list by the given key.
* @see query https://shopify.dev/api/storefront/2023-07/queries/products
* @see filters https://shopify.dev/api/storefront/2023-07/queries/products#argument-products-query
* @see query https://shopify.dev/api/storefront/current/queries/products
* @see filters https://shopify.dev/api/storefront/current/queries/products#argument-products-query
*/
export function FeaturedProducts({
count = 4,
Expand Down
4 changes: 2 additions & 2 deletions templates/demo-store/app/routes/($locale)._index.tsx
Expand Up @@ -204,7 +204,7 @@ const COLLECTION_HERO_QUERY = `#graphql
${COLLECTION_CONTENT_FRAGMENT}
` as const;

// @see: https://shopify.dev/api/storefront/2023-07/queries/products
// @see: https://shopify.dev/api/storefront/current/queries/products
export const HOMEPAGE_FEATURED_PRODUCTS_QUERY = `#graphql
query homepageFeaturedProducts($country: CountryCode, $language: LanguageCode)
@inContext(country: $country, language: $language) {
Expand All @@ -217,7 +217,7 @@ export const HOMEPAGE_FEATURED_PRODUCTS_QUERY = `#graphql
${PRODUCT_CARD_FRAGMENT}
` as const;

// @see: https://shopify.dev/api/storefront/2023-07/queries/collections
// @see: https://shopify.dev/api/storefront/current/queries/collections
export const FEATURED_COLLECTIONS_QUERY = `#graphql
query homepageFeaturedCollections($country: CountryCode, $language: LanguageCode)
@inContext(country: $country, language: $language) {
Expand Down
2 changes: 1 addition & 1 deletion templates/demo-store/app/routes/($locale).api.products.tsx
Expand Up @@ -12,7 +12,7 @@ import {PRODUCT_CARD_FRAGMENT} from '~/data/fragments';
* @param reverse
* @param sortKey
* @returns Product[]
* @see https://shopify.dev/api/storefront/2023-07/queries/products
* @see https://shopify.dev/api/storefront/current/queries/products
*/
export async function loader({
request,
Expand Down

0 comments on commit 2ff057d

Please sign in to comment.