From 3d9fe084447aba5b8a5930edd17235acc9a53828 Mon Sep 17 00:00:00 2001 From: Roman Typylo Date: Thu, 9 Jan 2025 11:03:02 +0200 Subject: [PATCH] [PR-23489] Fixed indentation, updated README --- README.md | 35 ++ source/advanced_features.rst | 112 ++--- .../converting_into_localization.rst | 4 +- source/advanced_features/coupons.rst | 18 +- .../customer_service_portal.rst | 18 +- .../customer_service_portal/overview.rst | 6 +- .../customer_service_portal/terminology.rst | 61 +-- .../customer_service_portal/use_case_1.rst | 2 +- .../customer_service_portal/use_case_2.rst | 2 +- .../customer_service_portal/use_case_3.rst | 2 +- .../customer_service_portal/use_case_4.rst | 2 +- .../customer_service_portal/use_case_5.rst | 6 +- .../customer_service_portal/use_case_6.rst | 2 +- source/advanced_features/events.rst | 156 +++---- .../facebook_login_share.rst | 8 +- source/advanced_features/file_encryption.rst | 14 +- source/advanced_features/google_login.rst | 5 +- source/advanced_features/multi_currency.rst | 57 ++- source/advanced_features/name_sharing.rst | 16 +- .../advanced_features/params_encryption.rst | 218 +++++----- .../advanced_features/passing_custom_data.rst | 24 +- .../personal_coupon_sharing.rst | 2 +- source/advanced_features/product_items.rst | 4 +- source/advanced_features/reg_ex.rst | 2 +- .../report_password_protection.rst | 8 +- source/advanced_features/rybbon.rst | 8 +- source/advanced_features/segments.rst | 61 ++- .../shopify_coupons_auto_apply.rst | 108 ++--- source/advanced_features/single_sign_on.rst | 32 +- .../subscribing_to_events.rst | 2 +- source/advanced_features/track_methods.rst | 20 +- source/advanced_features/tremendous.rst | 12 +- source/advanced_features/url_parameters.rst | 4 +- source/advanced_features/utm_tags.rst | 4 +- source/advanced_features/white_labeling.rst | 12 +- .../white_labeling/aws_route53.rst | 2 +- .../white_labeling/cloudflare.rst | 2 +- .../white_labeling/godaddy.rst | 8 +- .../white_labeling/shopify.rst | 8 +- source/android_sdk.rst | 14 +- source/android_sdk/advanced.rst | 122 +++--- source/android_sdk/api.rst | 232 +++++------ source/android_sdk/custom_deep_linking.rst | 94 ++--- source/android_sdk/deep_linking.rst | 206 +++++----- source/android_sdk/getting_started.rst | 160 ++++---- source/android_sdk/integration.rst | 6 +- source/android_sdk/integration/event.rst | 30 +- .../android_sdk/integration/post_purchase.rst | 76 ++-- source/android_sdk/integration/standalone.rst | 2 +- source/android_sdk/testing.rst | 18 +- source/android_sdk/upgrade.rst | 130 +++--- source/api_v2.rst | 8 +- source/api_v2/flow.rst | 2 +- source/api_v2/intro.rst | 76 ++-- source/api_v2/origins.rst | 12 +- source/api_v2/referrals.rst | 28 +- .../campaign_placements/loyalty_dashboard.rst | 2 +- .../campaign_placements/loyalty_widget.rst | 2 +- .../campaign_placements/post_purchase.rst | 4 +- .../campaign_placements/standalone.rst | 4 +- source/campaigns/campaign_types.rst | 30 +- source/campaigns/designer.rst | 12 +- source/campaigns/editor.rst | 14 +- source/campaigns/editor/files.rst | 17 +- source/campaigns/editor/filters.rst | 388 +++++++++--------- source/campaigns/editor/history.rst | 6 +- source/campaigns/editor/variables.rst | 152 +++---- source/campaigns/editor/videos.rst | 6 +- source/campaigns/localization.rst | 4 +- source/campaigns/offers_expiration.rst | 4 +- source/campaigns/tutorials.rst | 8 +- .../tutorials/incentive_criteria.rst | 8 +- source/campaigns/tutorials/offers_claim.rst | 2 +- source/campaigns/views.rst | 18 +- .../views/advocate_rewards_confirmation.rst | 2 +- .../campaigns/views/advocate_rewards_paid.rst | 6 +- .../campaigns/views/friend_rewards_paid.rst | 12 +- .../campaigns/views/notifier_offers_email.rst | 2 +- .../views/notifier_offers_share_via_email.rst | 4 +- ...tifier_offers_share_via_email_reminder.rst | 4 +- source/campaigns/views/offers_claim.rst | 22 +- source/campaigns/views/offers_show.rst | 44 +- source/custom_integration.rst | 14 +- source/custom_integration/chatgpt.rst | 2 +- source/custom_integration/crowdtwist.rst | 2 +- source/custom_integration/recharge.rst | 4 +- source/custom_integration/trustpilot.rst | 2 +- source/custom_integration/validity.rst | 2 +- source/email_marketing_and_automation.rst | 50 +-- .../email_marketing_and_automation/apsis.rst | 2 +- .../attentive.rst | 12 +- .../bluecore.rst | 2 +- .../email_marketing_and_automation/braze.rst | 2 +- .../cheetah.rst | 2 +- .../createsend.rst | 2 +- .../custom_app.rst | 208 +++++----- .../exponea.rst | 2 +- .../getresponse.rst | 2 +- .../hubspot.rst | 6 +- .../klaviyo.rst | 6 +- .../listrak.rst | 2 +- .../mailchimp.rst | 4 +- .../omnisend.rst | 2 +- .../oracle_bronto.rst | 6 +- .../sailthru.rst | 6 +- .../sendgrid.rst | 2 +- .../email_marketing_and_automation/sfmc.rst | 2 +- .../targetbay.rst | 2 +- source/integration/custom/cookies.rst | 73 ++-- .../custom/integration_components.rst | 50 +-- .../custom/integration_tag_manager.rst | 6 +- source/integration/custom/overview.rst | 28 +- .../custom/validating_integration.rst | 6 +- source/integration/custom_integration.rst | 14 +- source/integration/ecommerce_platforms.rst | 8 +- .../ecommerce_platforms/demandware.rst | 2 +- .../ecommerce_platforms/magento.rst | 6 +- .../ecommerce_platforms/magento/magento1.rst | 6 +- .../ecommerce_platforms/magento/magento2.rst | 48 +-- .../ecommerce_platforms/shopify.rst | 130 +++--- source/integration/loyalty.rst | 26 +- .../integration/loyalty/auto_enrollment.rst | 40 +- source/integration/loyalty/custom_app.rst | 2 +- .../loyalty/integration_components.rst | 46 +-- .../loyalty/shopify_integration.rst | 54 +-- source/ios_sdk.rst | 14 +- source/ios_sdk/advanced.rst | 10 +- source/ios_sdk/api_integration.rst | 60 +-- source/ios_sdk/custom_deep_linking.rst | 46 +-- source/ios_sdk/example.rst | 2 +- source/ios_sdk/getting_started.rst | 6 +- source/ios_sdk/integration.rst | 8 +- source/ios_sdk/integration/post_purchase.rst | 44 +- source/ios_sdk/integration/standalone.rst | 2 +- source/ios_sdk/social_sharing.rst | 80 ++-- source/partials/common.rst | 2 +- source/partials/coupon_as_reward.rst | 16 +- source/partials/developer_email_note.rst | 6 +- source/partials/incentive_types.rst | 2 +- source/partials/note_sample_code.rst | 2 +- source/web_hooks/check_unsubscribe.rst | 14 +- source/web_hooks/claim_signup.rst | 10 +- source/web_hooks/create_coupon.rst | 20 +- source/web_hooks/event.rst | 6 +- source/web_hooks/offer_signup.rst | 10 +- source/web_hooks/post_share.rst | 14 +- source/web_hooks/referral.rst | 18 +- source/web_hooks/reward.rst | 34 +- source/web_hooks/unsubscribe.rst | 6 +- 149 files changed, 2205 insertions(+), 2180 deletions(-) diff --git a/README.md b/README.md index 6f23ceb9c..435210e0a 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,41 @@ Here is a reference to "talkable section": :ref:`talkable-section` which will ha name "Talkable Section". ``` +### Coding Guidelines for Documentation + +#### General Formatting Rules + +1. **Directives (`..` syntax)**: + - All directives starting with `..` (e.g., `.. image::`, `.. note::`) must have **2 spaces** indentation for their content. Examples: + + ```rst + .. image:: /_static/img/example.jpg + :alt: Example Image + + .. note:: + This is an important note. + ``` + +2. **Meta Directives (`.. meta::`)**: + - For `.. meta::` blocks, use **3 spaces** for the content indentation. Example: + + ```rst + .. meta:: + :description: This is an example of a meta directive. + ``` + +3. **Code Blocks (`.. code-block::`)**: + - Code inside `.. code-block::` must have **2 spaces** indentation. Example: + + ```rst + .. 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..5b5aa2953 100644 --- a/source/advanced_features.rst +++ b/source/advanced_features.rst @@ -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..7940608d7 100644 --- a/source/advanced_features/converting_into_localization.rst +++ b/source/advanced_features/converting_into_localization.rst @@ -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