From 5fa40995690966465d736fa0f9712f7e6a5e2b4e Mon Sep 17 00:00:00 2001 From: Douglas Egiemeh Date: Fri, 30 Sep 2022 13:09:17 +0200 Subject: [PATCH 1/4] feat(page title docs): improve docs punctuations and some gramatical structures --- .../commercetools-frontend-application-shell.mdx | 8 ++++---- website/src/releases/2022-09/readable-page-title.mdx | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx index bc4275e0cf..3904822644 100644 --- a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx +++ b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx @@ -82,11 +82,11 @@ This feature is available from version `21.15.0` onwards. -This component can be used to overwrite the default document's ``. +Use this component to overwrite the document's default <title> ### Usage -We recommend to render this component in pages where there is a human-readable resource identifier, for example a Product name in the product details page. +We recommend using this component on pages with a human-readable resource identifier, for example, a Product name on the product details page. ```js import { ApplicationPageTitle } from '@commercetools-frontend/application-shell'; @@ -95,11 +95,11 @@ import { ApplicationPageTitle } from '@commercetools-frontend/application-shell' // Red shoes - Products - my-shop - Merchant Center ``` -The `<ApplicationPageTitle>` component can be rendered multiple times and the last one rendered will overwrite the previous ones. +When the <ApplicationPageTitle> component is used multiple times, the last one rendered will overwrite the previous ones. <Info> -Please refer to the [Mapping guidelines](/development/human-readable-page-title#mapping-guidelines) to understand when you should overwrite the title and when not. +Please refer to the [Mapping guidelines](/development/human-readable-page-title#mapping-guidelines) to understand when to overwrite the title and when not. </Info> diff --git a/website/src/releases/2022-09/readable-page-title.mdx b/website/src/releases/2022-09/readable-page-title.mdx index 78614000a1..5b5c620e1d 100644 --- a/website/src/releases/2022-09/readable-page-title.mdx +++ b/website/src/releases/2022-09/readable-page-title.mdx @@ -1,7 +1,7 @@ --- date: 2022-09-29 title: Human-readable page titles -description: Introducing more granular and readable document's titles for all Merchant Center pages to help users identifying the context of the page. +description: Introducing more granular and readable document titles for all Merchant Center pages to help users identify the page's context. type: feature topics: - Merchant Center From 08e69330d4c972b77b66d72f882cf2199a00e264 Mon Sep 17 00:00:00 2001 From: Douglas Egiemeh <douglasegiemeh@Douglass-MacBook-Pro-2.local> Date: Fri, 30 Sep 2022 13:12:09 +0200 Subject: [PATCH 2/4] feat(page title docs): improve docs punctuations --- website/src/releases/2022-09/readable-page-title.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/src/releases/2022-09/readable-page-title.mdx b/website/src/releases/2022-09/readable-page-title.mdx index 5b5c620e1d..4e11471dda 100644 --- a/website/src/releases/2022-09/readable-page-title.mdx +++ b/website/src/releases/2022-09/readable-page-title.mdx @@ -8,6 +8,6 @@ topics: - UI Components --- -Custom Applications use a more readable document's title by default, which can be customized. You can read more about this feature in the [`Human-readable page title`](/development/human-readable-page-title) documentation. +Custom Applications now use a more readable, customizable document title by default. You can read more about this feature in the [`Human-readable page title`](/development/human-readable-page-title) documentation. -As always, if you have questions or feedback you can open a [GitHub Discussion](https://github.com/commercetools/merchant-center-application-kit/discussions) or a [GitHub Issue](https://github.com/commercetools/merchant-center-application-kit/issues). +As always, if you have questions or feedback, you can open a [GitHub Discussion](https://github.com/commercetools/merchant-center-application-kit/discussions) or a [GitHub Issue](https://github.com/commercetools/merchant-center-application-kit/issues). From f06a481bcd45312358187f211a8659a69fdb53ba Mon Sep 17 00:00:00 2001 From: Douglas Egiemeh <douglasegiemeh@Douglass-MacBook-Pro-2.local> Date: Fri, 30 Sep 2022 14:01:46 +0200 Subject: [PATCH 3/4] feat(page title docs): remove code formatting from links --- .../commercetools-frontend-application-shell.mdx | 8 ++++---- website/src/releases/2022-09/readable-page-title.mdx | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx index 3904822644..783988af68 100644 --- a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx +++ b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx @@ -82,7 +82,7 @@ This feature is available from version `21.15.0` onwards. </Info> -Use this component to overwrite the document's default <title> +Use this component to overwrite the document's default `<title>`. ### Usage @@ -113,15 +113,15 @@ Please refer to the [Mapping guidelines](/development/human-readable-page-title# ## useMcQuery -A React hook that wraps the [`useQuery`](https://www.apollographql.com/docs/react/data/queries/) hook of Apollo Client. The only difference is that `useMcQuery` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). +A React hook that wraps the [useQuery](https://www.apollographql.com/docs/react/data/queries/) hook of Apollo Client. The only difference is that `useMcQuery` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). ## useMcLazyQuery -A React hook that wraps the [`useLazyQuery`](https://www.apollographql.com/docs/react/data/queries/#manual-execution-with-uselazyquery) hook of Apollo Client. The only difference is that `useMcLazyQuery` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). +A React hook that wraps the [useLazyQuery](https://www.apollographql.com/docs/react/data/queries/#manual-execution-with-uselazyquery) hook of Apollo Client. The only difference is that `useMcLazyQuery` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). ## useMcMutation -A React hook that wraps the [`useMutation`](https://www.apollographql.com/docs/react/data/mutations/) hook of Apollo Client. The only difference is that `useMcMutation` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). +A React hook that wraps the [useMutation](https://www.apollographql.com/docs/react/data/mutations/) hook of Apollo Client. The only difference is that `useMcMutation` properly types the `context` object, which is always used to define the GraphQL `target`. See [Data Fetching](/development/data-fetching). # Utilities diff --git a/website/src/releases/2022-09/readable-page-title.mdx b/website/src/releases/2022-09/readable-page-title.mdx index 4e11471dda..25395a7fbb 100644 --- a/website/src/releases/2022-09/readable-page-title.mdx +++ b/website/src/releases/2022-09/readable-page-title.mdx @@ -8,6 +8,6 @@ topics: - UI Components --- -Custom Applications now use a more readable, customizable document title by default. You can read more about this feature in the [`Human-readable page title`](/development/human-readable-page-title) documentation. +Custom Applications now use a more readable, customizable document title by default. You can read more about this feature in the [Human-readable page title](/development/human-readable-page-title) documentation. As always, if you have questions or feedback, you can open a [GitHub Discussion](https://github.com/commercetools/merchant-center-application-kit/discussions) or a [GitHub Issue](https://github.com/commercetools/merchant-center-application-kit/issues). From 999c6902162d30ce40e354a9878f37c17e577422 Mon Sep 17 00:00:00 2001 From: Douglas Egiemeh <douglasegiemeh@Douglass-MacBook-Pro-2.local> Date: Fri, 30 Sep 2022 14:10:49 +0200 Subject: [PATCH 4/4] feat(page title docs): add missing mdx formating --- .../api-reference/commercetools-frontend-application-shell.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx index 783988af68..2a74192a3c 100644 --- a/website/src/content/api-reference/commercetools-frontend-application-shell.mdx +++ b/website/src/content/api-reference/commercetools-frontend-application-shell.mdx @@ -95,7 +95,7 @@ import { ApplicationPageTitle } from '@commercetools-frontend/application-shell' // Red shoes - Products - my-shop - Merchant Center ``` -When the <ApplicationPageTitle> component is used multiple times, the last one rendered will overwrite the previous ones. +When the `<ApplicationPageTitle>` component is used multiple times, the last one rendered will overwrite the previous ones. <Info>