Skip to content

Commit

Permalink
Update readable page title document with feedback (#2836)
Browse files Browse the repository at this point in the history
* feat(page title docs): improve docs punctuations and some gramatical structures

* feat(page title docs): improve docs punctuations

* feat(page title docs): remove code formatting from links

* feat(page title docs): add missing mdx formating

Co-authored-by: Douglas Egiemeh <douglasegiemeh@Douglass-MacBook-Pro-2.local>
  • Loading branch information
ddouglasz and Douglas Egiemeh authored Oct 4, 2022
1 parent 1ddac8c commit 20c0be8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ This feature is available from version `21.15.0` onwards.

</Info>

This component can be used to overwrite the default document's `<title>`.
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';
Expand All @@ -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>

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions website/src/releases/2022-09/readable-page-title.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
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
- 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).

1 comment on commit 20c0be8

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for merchant-center-application-kit ready!

✅ Preview
https://merchant-center-application-2bugpuftm-commercetools.vercel.app

Built with commit 20c0be8.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.