diff --git a/README.md b/README.md index 6f23ceb9c..f2c07f7a8 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,30 @@ Here is a reference to "talkable section": :ref:`talkable-section` which will ha name "Talkable Section". ``` +### General Formatting Rules for Documentation + +**Directives (`..` syntax)**: + +* All directives starting with `..` (e.g., `.. image::`, `.. note::`) must have **2 spaces** indentation for their content. Examples: + + ```rst + .. meta:: + :description: This is an example of a meta directive. + + .. image:: /_static/img/example.jpg + :alt: Example Image + + .. note:: + This is an important note. + + .. code-block:: html +

Hello world!

+ ``` + +#### Empty Line at the End of Files + +Always ensure there is a blank line at the end of each file to adhere to formatting standards. + Build the documentation ----------------------- diff --git a/source/advanced_features.rst b/source/advanced_features.rst index a2e962f9c..562cfe443 100644 --- a/source/advanced_features.rst +++ b/source/advanced_features.rst @@ -2,7 +2,7 @@ .. include:: /partials/common.rst .. meta:: - :description: Talkable provides optional features for your referral program. Unlock them to increase conversions. + :description: Talkable provides optional features for your referral program. Unlock them to increase conversions. Features ######## @@ -12,85 +12,85 @@ and make your referral program incredibly easy to manage. Here’s an overview o each with links to integration details. .. list-table:: - :widths: 35 65 + :widths: 35 65 - * - :ref:`Automatic Coupon Creation ` - - Issue single and multi-use coupons for your campaigns + * - :ref:`Automatic Coupon Creation ` + - Issue single and multi-use coupons for your campaigns - * - :ref:`Shopify Coupon auto-sync ` - - Issue coupons automatically for your Shopify store + * - :ref:`Shopify Coupon auto-sync ` + - Issue coupons automatically for your Shopify store - * - :ref:`Shopify Coupon auto-apply ` - - Issue coupons automatically for your Shopify store + * - :ref:`Shopify Coupon auto-apply ` + - Issue coupons automatically for your Shopify store - * - :ref:`Shopify Purchase Syncing ` - - Automatic purchases synchronization from your Shopify store + * - :ref:`Shopify Purchase Syncing ` + - Automatic purchases synchronization from your Shopify store - * - :ref:`Referral Tracking Methods ` - - See how Talkable tracks referrals and what data is used in the tracking process + * - :ref:`Referral Tracking Methods ` + - See how Talkable tracks referrals and what data is used in the tracking process - * - :ref:`Advocate Personal Coupon Sharing ` - - Find out how to add personal coupon sharing into a Talkable campaign in addition to link sharing + * - :ref:`Advocate Personal Coupon Sharing ` + - Find out how to add personal coupon sharing into a Talkable campaign in addition to link sharing - * - :ref:`Convert static copy into Localization ` - - Convert all static languange into a customizable copy that’s - easy to AB test. + * - :ref:`Convert static copy into Localization ` + - Convert all static languange into a customizable copy that’s + easy to AB test. - * - :ref:`Сustomer Service Portal ` - - Explore full details for each individual customer and their referral journey, - manage their rewards and deliver excellent customer service. + * - :ref:`Сustomer Service Portal ` + - Explore full details for each individual customer and their referral journey, + manage their rewards and deliver excellent customer service. - * - :ref:`Params encryption ` - - For additional security, it is possible to encrypt Advocate, Friend and Loyalty member emails on back-end, - as well as their custom properties. + * - :ref:`Params encryption ` + - For additional security, it is possible to encrypt Advocate, Friend and Loyalty member emails on back-end, + as well as their custom properties. - * - :ref:`File encryption ` - - For additional security, it is possible to encrypt files. + * - :ref:`File encryption ` + - For additional security, it is possible to encrypt files. - * - :ref:`Report password protection ` - - For additional security, reports have password protection by default. + * - :ref:`Report password protection ` + - For additional security, reports have password protection by default. - * - :ref:`Including Product Items ` - - Let your customers share specific items that they’ve purchased - and pass product details along with purchase data + * - :ref:`Including Product Items ` + - Let your customers share specific items that they’ve purchased + and pass product details along with purchase data - * - :ref:`Integrating Events ` - - Fits SaaS, subscription-based, and other businesses that require integrating - additional events to build more advanced referral logics on top of regular - purchases. + * - :ref:`Integrating Events ` + - Fits SaaS, subscription-based, and other businesses that require integrating + additional events to build more advanced referral logics on top of regular + purchases. - * - :ref:`Pass custom user data ` - - Pass additional data to Talkable to operate with it inside campaigns + * - :ref:`Pass custom user data ` + - Pass additional data to Talkable to operate with it inside campaigns - * - :ref:`Phone number gating ` - - Collect customers' phone numbers and sync with ESPs. + * - :ref:`Phone number gating ` + - Collect customers' phone numbers and sync with ESPs. - * - :ref:`Referrals Approval ` - - Learn about Talkable Fraud settings, why they are important - and how to find a right Fraud Profile that works best for your site. + * - :ref:`Referrals Approval ` + - Learn about Talkable Fraud settings, why they are important + and how to find a right Fraud Profile that works best for your site. - * - :ref:`Segments ` - - Brings more power and flexibility into segmenting your reporting + * - :ref:`Segments ` + - Brings more power and flexibility into segmenting your reporting - * - :ref:`Subscribing to Talkable Iframe events ` - - Subscribe to Talkable Iframe events such as the campaign is loaded or closed and - perform some updates to your site based on them. + * - :ref:`Subscribing to Talkable Iframe events ` + - Subscribe to Talkable Iframe events such as the campaign is loaded or closed and + perform some updates to your site based on them. - * - :ref:`Setting up Campaign Placement criteria ` - - Walking through a Campaign Placement criteria setup that can support multiple - matching techniques + * - :ref:`Setting up Campaign Placement criteria ` + - Walking through a Campaign Placement criteria setup that can support multiple + matching techniques - * - :ref:`Using URL Parameters ` - - Override some of the parameters right through URL query string + * - :ref:`Using URL Parameters ` + - Override some of the parameters right through URL query string - * - :ref:`UTM Tags ` - - Brings more power and flexibility into segmenting your reporting by UTM tags + * - :ref:`UTM Tags ` + - Brings more power and flexibility into segmenting your reporting by UTM tags - * - :ref:`White Labeling ` - - Change all visible URLs to your domain instead of talkable.com + * - :ref:`White Labeling ` + - Change all visible URLs to your domain instead of talkable.com - * - :ref:`Multi-Currency ` - - Accept multiple currencies and set different rewards per currency + * - :ref:`Multi-Currency ` + - Accept multiple currencies and set different rewards per currency .. container:: hidden diff --git a/source/advanced_features/converting_into_localization.rst b/source/advanced_features/converting_into_localization.rst index 25e586161..d963fafed 100644 --- a/source/advanced_features/converting_into_localization.rst +++ b/source/advanced_features/converting_into_localization.rst @@ -2,7 +2,7 @@ .. include:: /partials/common.rst .. meta:: - :description: This is a how-to guide to help you get the most out of Localizations. + :description: This is a how-to guide to help you get the most out of Localizations. Converting Into Localization ============================ @@ -57,7 +57,7 @@ A piece that we are going to extract into Localizations is just a copy, without .. warning:: - Talkable does not allow coding up Localizations within CSS area. If you want to move some CSS property into localizations use inline