# Guide

## How to add "Product Page Descriptions Hey!" to your store!

## 1. Step - Text&#x20;

In the first step, you will write the message that you want to highlight by using the product page description banner.

* **Title Text:** You can write the title text for the banner. If you don't prefer the title, it's okay. You can leave it empty.&#x20;
* **Body Text:** You can write the details of your message in the body text.  If you don't prefer body text, it's okay. You can leave it empty.&#x20;
* **Add Dynamic Text to Title:** You can add dynamic text to your title, like variant inventory and total inventory. When you click "Add Dynamic Text to Title" a real inventory figure will appear in the title. If you want to delete a dynamic text figure, you can delete this " {{variant\_inventory}}" in the title text.&#x20;
* **Add Dynamic Text to Body:** You can add dynamic text to your body, like variant inventory and total inventory. When you click "Add Dynamic Text to Body" a real inventory figure will appear in the body text section. If you want to delete a dynamic text figure, you can delete this " {{variant\_inventory}}" in the body text.&#x20;
* **Icon:** You can choose some icons to show in the widget with the title and text. Icons can be displayed on the left, on the right, or both sides of the widget. If you don't prefer emojis, it's okay. You can click on none. Without an icon, you can only display text messages.\
  **Icon size** can be adjusted by using the arrow keys to increase or decrease the size. The preview section will show the changes in real time as the size is modified.
* **Link:** To create a clickable widget, you can pass a link to this section.

{% hint style="info" %}
Click <mark style="background-color:purple;">"Save\&Next"</mark> to save the changes you made and continue editing the widget.
{% endhint %}

## 2. Step - Formatting&#x20;

In the second step, you will format the text color, size, font, and alignment. Also, format the block color, size, and style.&#x20;

### Formatting The Title&#x20;

{% hint style="info" %}
This section will only be visible if you wrote a title in the previous step.
{% endhint %}

* **Title Color:** The title color comes black automatically. If you want to change black to another color, click "Title Color" and pick a color from the color palette.
* **Title Font:** The title font is Arial by default. However, you can choose another font by choosing from the list.&#x20;
* **Title Font Size:** If you want to display the title bigger or smaller, you can arrange it in the title font size.&#x20;
* **Title Alignment:** You can align the title to left, right, or center.

### Formatting The Body Text

{% hint style="info" %}
This section will only be visible if you wrote a boy text in the previous step.
{% endhint %}

* **Body Text Color:** The body text color comes black automatically. If you want to change black to another color, click "Body Color" and pick a color from the color palette.
* **Body Text Font:** The body text font is Arial by default. However, you can choose another font by choosing from the list.&#x20;
* **Body Text Font Size:** If you want to display the body text bigger or smaller, you can arrange it in the body font size.&#x20;
* **Body Text Alignment:** You can align the body text to the left, right, or center.&#x20;

### Formatting The Block &#x20;

In the Block section, you will be able to design the style of a widget. &#x20;

* **Background Color:** You can create a colorful widget by choosing your desired color from the background color palette.
* **Space at the Top:** This enables putting some space between a widget and the button or text below the widget from the top part of the widget. As well as space between the other widgets if you have created multiple widgets.
* **Space at the Bottom:** This enables putting some space between a widget and the button or text below the widget from the bottom part of the widget. As well as space between the other widgets if you have created multiple widgets.
* **Block Size:** You can change the width of a widget by changing the block size.&#x20;

{% hint style="warning" %}
Maximum block size is 25px. If you need more than that you can send a message by using live chat inside the app.
{% endhint %}

* **Block Radius:** This will help you to round the edge of your widget. The more you increase the radius, the more round a widget gets.
* **Block Alignment:** The block can be aligned to the left, right, or center.&#x20;
* <mark style="color:purple;background-color:purple;">Select Your Own Page Background Color:</mark> You can choose your page's original background color to see how it looks together with the widget you create. The changes will be shown in the preview.&#x20;
* <mark style="background-color:yellow;">Transparent Background:</mark> When you choose the transparent background option, the widget background will be transparent.
* **Shadow:** You can give a shadow to a widget by clicking shadow.&#x20;

- [x] **Use border:** You can use the widget border by selecting the use border option. When you click it two more formatting options will be shown.&#x20;

&#x20;       **Border Color:** You can choose the desired color for a border.

&#x20;       **Border Width:** You can change the width of a border.&#x20;

{% hint style="info" %}
Click <mark style="background-color:purple;">"Save\&Next"</mark> to save the changes you made and continue editing the widget.
{% endhint %}

## 3. Step - Conditions&#x20;

The third step is the final setting step to set up conditions and rules.

* **Display Widget for** You can display the created widgets for All Products, Custom Products, or Custom Collection.  The widget will be shown based on your choice.&#x20;

{% hint style="warning" %}
Make sure to choose products or collections from the list after selecting the radio button for custom products or custom collections.
{% endhint %}

<figure><img src="https://3608867894-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkwNkMAfCmI9_U57db_%2Fuploads%2FlD1ROSkntRFRQF5l1Dz3%2FScreen%20Shot%202022-11-09%20at%2016.33.35.png?alt=media&#x26;token=882fa1fc-98cc-4aff-966c-938029f51e26" alt=""><figcaption><p>Display Widget </p></figcaption></figure>

* **Position:** By selecting the option provided here, you can choose to display the widget either above or below the add-to-cart button. \
  \
  \&#xNAN;*In case you face any issues, feel free to reach out to us through the app's live chat and we will assist you.*

{% hint style="info" %}
Do not forget the "SAVE" the changes.
{% endhint %}

## 4. Step - Publish&#x20;

In the final step, you will publish the app in your store based on your previous inputs and this step <mark style="background-color:red;">only needs to be done once.</mark>&#x20;

> <mark style="color:purple;">Product Page Descriptions Hey! is compatible with "Online Store 2.0" and old version themes. Please follow publishing option according to your store theme.</mark>

### Publishing for Online 2.0 Themes &#x20;

*If your is Online 2.0, you need to follow the steps below:*

{% hint style="info" %}
There are two options for Online 2.0 Stores. However, please only go with one. Otherwise, the widget might be duplicated on your store.&#x20;
{% endhint %}

#### Option A via "Add Block" for Online 2.0 Themes&#x20;

* Click "Theme Editor" inside the app.
* Go to the "Default Product" page.
* On the left side navigation, click the "Add block" in the "Product information" section.
* Choose "<mark style="color:purple;">Product Page Descriptions Hey!",</mark> then drag and drop wherever you want.
* Don't forget to click "Save" in the theme editor.

*You can watch the video below to follow the instructions.* &#x20;

{% embed url="<https://youtu.be/hGY8HtdkoJU>" %}
Online 2.0 themes
{% endembed %}

{% hint style="danger" %}
However, some Online 2.0 themes do not allow merchants to drag and drop the app wherever they want. Thus, we have option B.&#x20;
{% endhint %}

#### Option B via "App Embeds" for Online 2.0 Themes &#x20;

* Click "Theme Editor" inside the app.
* Click on the app embeds icon on the left.
* Enable the app by switching the button.
* Our app should automatically appear above the add to cart button.
* Don't forget to click "Save" in the theme editor.

*You can watch the video below to follow the instructions.* &#x20;

{% embed url="<https://youtu.be/rfuc0yTyQ0A>" %}
App Embed Option for Online 2.0
{% endembed %}

#### :bangbang:*<mark style="background-color:yellow;">Please be sure that you only enable us with one method. Otherwise, our app might be duplicated on your product page.</mark>*&#x20;

### Publishing for non-Online 2.0 Themes&#x20;

*If your is  not Online 2.0, you need to follow the steps below:*

* Click the "Theme Editor" inside the app.
* Then click on the  "App Embeds" icon on the left.&#x20;
* Enable the app by switching the button.
* Our app should automatically appear above the add to cart button.
* Don't forget to "Save" in the theme editor.

*You can watch the video below to follow the instructions.* &#x20;

{% embed url="<https://youtu.be/rfuc0yTyQ0A>" %}
Publishing via App Embed
{% endembed %}

{% hint style="warning" %}
If you still cannot see the counter in your store, please reach out to us **<info@heymerch.net>**
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://heymerch.gitbook.io/hey/product-page-descriptions/guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
