Merge branch 'user-guides-pub' into link-fix

Author: Shreyaakothari

.github/workflows/grammar-nazi.yml

@@ -18,4 +18,4 @@ jobs:
       - name: 🧹 Run markdownlint
         uses: DavidAnson/markdownlint-cli2-action@v13
         with:
-          globs: '**/*.md'
+          globs: '**/*.md'

.markdownlint.jsonc

@@ -1,19 +1,60 @@
 {
-  "MD009": true,     // Disallow trailing spaces at the end of lines
-  "MD012": true,     // Disallow multiple consecutive blank lines
-  "MD018": true,     // Headings must have a space after the # (e.g., "# Heading")
-  "MD019": true,     // Disallow multiple spaces after the # in headings
-  "MD022": true,     // Headings must be surrounded by blank lines above and below
-  "MD023": true,     // Headings must start at the beginning of the line (no leading spaces)
-  "MD025": true,     // Disallow multiple top-level headings (only one "# Heading" per file)
-  "MD026": true,     // Disallow punctuation at the end of headings (e.g., "Heading?" or "Heading:")
-  "MD028": true,     // Disallow blank lines inside list items
-  "MD030": true,     // Enforce consistent spacing after list markers (e.g., "- item", not "-item")
-  "MD031": true,     // Fenced code blocks must be surrounded by blank lines before and after
-  "MD032": true,     // Lists must be surrounded by blank lines above and below
-  "MD034": true,     // Disallow bare URLs — require using [text](url) format
-  "MD037": true,     // Disallow spaces inside emphasis markers (e.g., "* bold *" is invalid — use "*bold*")
-  "MD042": true,     // Disallow empty links (e.g., "[](url)" or "[text]()")
-  "MD045": true,     // Require alt text for all images (accessibility best practice)
-  "MD051": true      // Ensure internal link fragments (e.g., [Link](#heading)) match actual headings
+  "MD001": false,     // Heading levels should only increment by one level at a time
+  "MD002": false,     // First heading should be a top-level heading (e.g., "# Heading")
+  "MD003": false,     // Heading style should be consistent (e.g., ATX vs Setext)
+  "MD004": false,     // Unordered list style should be consistent
+  "MD005": false,     // Inconsistent indentation for list items
+  "MD006": false,     // Indentation for list items should be multiple of 2 spaces
+  "MD007": false,     // List item indentation should be consistent within the list
+  "MD008": false,     // Lists should be surrounded by blank lines (alternate form)
+  "MD009": true,      // Disallow trailing spaces at the end of lines
+  "MD010": false,     // Hard tabs are discouraged
+  "MD011": false,     // Reversed link syntax is not allowed
+  "MD012": true,      // Disallow multiple consecutive blank lines
+  "MD013": false,     // Do not enforce line length limits (disabled by choice)
+  "MD014": false,     // Dollar signs used before commands without showing output
+  "MD015": false,     // No spaces after list item marker (alternate form)
+  "MD016": false,     // Line beginning with whitespace
+  "MD017": false,     // Numbers in ordered lists should be sequential
+  "MD018": true,      // Headings must have a space after the # (e.g., "# Heading")
+  "MD019": true,      // Disallow multiple spaces after the # in headings
+  "MD020": false,     // No space inside hashes in headings (e.g., "#Heading#")
+  "MD021": false,     // No multiple spaces inside headings (alternative to MD019)
+  "MD022": true,      // Headings must be surrounded by blank lines above and below
+  "MD023": true,      // Headings must start at the beginning of the line (no leading spaces)
+  "MD024": false,     // Multiple headings with the same content are not allowed
+  "MD025": true,      // Disallow multiple top-level headings (only one "# Heading" per file)
+  "MD026": true,      // Disallow punctuation at the end of headings (e.g., "Heading?" or "Heading:")
+  "MD027": false,     // Multiple spaces between blockquote marker and content
+  "MD028": true,      // Disallow blank lines inside list items
+  "MD029": false,     // Ordered list item prefix should be one style (e.g., always "1.")
+  "MD030": true,      // Enforce consistent spacing after list markers (e.g., "- item", not "-item")
+  "MD031": true,      // Fenced code blocks must be surrounded by blank lines before and after
+  "MD032": true,      // Lists must be surrounded by blank lines above and below
+  "MD033": false,     // Allow inline HTML (useful for GitBook styling and custom formatting)
+  "MD034": [
+    true,
+    {
+      "ignorePatterns": [
+        "{% embed url=\"https://.*?\" %}"  // Ignore GitBook embed syntax for YouTube and others
+      ]
+    }
+  ],                  // Disallow bare URLs, but skip your {% embed %} lines
+  "MD035": false,     // Horizontal rule style should be consistent (e.g., "---" vs "***")
+  "MD036": false,     // Emphasis style should be consistent (e.g., "*" vs "_")
+  "MD037": true,      // Disallow spaces inside emphasis markers (e.g., "* bold *" is invalid — use "*bold*")
+  "MD038": false,     // Spaces inside code span markers (e.g., "` code `")
+  "MD039": false,     // Spaces inside link text
+  "MD040": false,     // Fenced code block language should be specified
+  "MD041": false,     // First line in file should be a top-level heading
+  "MD042": true,      // Disallow empty links (e.g., "[](url)" or "[text]()")
+  "MD043": false,     // List items should be in a bulleted or numbered form consistently
+  "MD044": false,     // Proper names should have correct capitalization
+  "MD045": true,      // Require alt text for all images (accessibility best practice)
+  "MD046": false,     // Code block style should be consistent
+  "MD047": false,     // Files should end with a single newline character
+  "MD048": false,     // Code fences should use consistent style ("```" vs "~~~")
+  "MD049": false,     // Emphasis should not be used for headers
+  "MD050": false,     // Strong emphasis should not be used in headers
+  "MD051": true       // Link fragments must match actual headings in the document
 }

documents/README.md

@@ -28,7 +28,7 @@ Find direct access to resources tailored for **Store Operations, Retail Operatio
 Explore the sections **"Learn HotWax OMS," "Learn Shopify," and "Learn NetSuite,"** empowering users to maximize the
 potential of HotWax Commerce for your businesses.
 
-## Resources :desktop:
+## Resources :desktop
 
 <table data-view="cards">
   <thead>
@@ -71,7 +71,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Learn HotWax OMS :orange\_book:
+## Learn HotWax OMS :orange\_book
 
 <table data-view="cards">
   <thead>
@@ -102,7 +102,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Store Operations User Manual :convenience\_store:
+## Store Operations User Manual :convenience\_store
 
 <table data-view="cards">
   <thead>
@@ -162,7 +162,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Retail Operations User Manual :department\_store:
+## Retail Operations User Manual :department\_store
 
 <table data-view="cards">
   <thead>
@@ -229,7 +229,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## System Admin User Manual :video\_game:
+## System Admin User Manual :video\_game
 
 <table data-view="cards">
   <thead>
@@ -274,7 +274,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Learn Shopify :green\_book:
+## Learn Shopify :green\_book
 
 <table data-view="cards">
   <thead>
@@ -319,7 +319,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Learn NetSuite :blue\_book:
+## Learn NetSuite :blue\_book
 
 <table data-view="cards">
   <thead>
@@ -356,7 +356,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Integrate with HotWax :dart:
+## Integrate with HotWax :dart
 
 <table data-view="cards">
   <thead>
@@ -387,7 +387,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Additional Integrations :jigsaw:
+## Additional Integrations :jigsaw
 
 <table data-view="cards">
   <thead>
@@ -428,7 +428,7 @@ potential of HotWax Commerce for your businesses.
   </tbody>
 </table>
 
-## Analytics :bar\_chart:
+## Analytics :bar\_chart
 
 <table data-view="cards">
   <thead>

documents/additional-integrations/SUMMARY.md

@@ -1,6 +1,7 @@
 # Table of contents
+
 * [HotWax Integrations](README.md)
-  
+
 ## RetailPro
 
 * [Introduction](retailpro/README.md)
@@ -17,14 +18,12 @@
   * [Technical Workflow](retailpro/flows/sendsale-order/technical-workflow.md)
 
 * [Returns](retailpro/flows/returns/README.md)
-  
 
 ## Loop
 
 * [Returns](loop/loop-online.md)
 * [Exchanges](loop/loop-exchanges.md)
 
-
 ##  Klaviyo
 
 * [Klaviyo Integration](marketing-automations-platform/klaviyo.md)

documents/additional-integrations/carriers/easy-post.md

@@ -34,17 +34,17 @@ HotWax integrates with EasyPost using three key APIs, each serving a distinct pu
 
 ### Create a Shipment API
 
-#### Purpose:
+#### Purpose
 
 **Create Shipment API** shares all detailed shipment information with EasyPost, including package dimensions, weight, origin, and destination. In return, the API offers competitive rates from multiple carriers. For added flexibility, users can specify preferred carriers and their corresponding credentials. The API also generates custom shipping labels with adjustable size and format options.
 
 **In case of international shipping:**
 
 Fulfilling international orders requires accurate customs information for generating shipping labels and obtaining customs documents. While HotWax stores product details, it lacks the essential HS Tariff number and Custom Signer information for customs purposes.
 
-HotWax integrates with your ERP system, automatically fetching HS Tariff numbers for products during order fulfillment. This daily synchronization ensures readily available HS codes whenever new products are added. HotWax stores these retrieved HS Tariff numbers alongside existing Good identifications for each product. 
+HotWax integrates with your ERP system, automatically fetching HS Tariff numbers for products during order fulfillment. This daily synchronization ensures readily available HS codes whenever new products are added. HotWax stores these retrieved HS Tariff numbers alongside existing Good identifications for each product.
 
-Alongside, HS tariff number of the product, EasyPost also requires a custom_signer value during shipment creation to validate the request. HotWax retrieves the designated custom signer value assigned by retailer stored in system properties in OMS. 
+Alongside, HS tariff number of the product, EasyPost also requires a custom_signer value during shipment creation to validate the request. HotWax retrieves the designated custom signer value assigned by retailer stored in system properties in OMS.
 
 Once both HS Tariff numbers and custom signer information are available, HotWax constructs a streamlined create shipment API request to EasyPost and generate shipping label.
 
@@ -56,7 +56,7 @@ Once both HS Tariff numbers and custom signer information are available, HotWax
 https://api.easypost.com/v2/shipments
 ```
 
-#### Request:
+#### Request
 
 <details>
 
@@ -158,7 +158,7 @@ https://api.easypost.com/v2/shipments
 | shipment.carrier_accounts | (not specified) | List of carrier accounts (optional) |
 | shipment.carrier_accounts[] | facilityAttribute.attrName.carrierAccounts | Individual carrier account |
 
-#### Response:
+#### Response
 
 {% hint style="info" %}
 `EasyPost` consistently structures its responses, maintaining a common format. Unique details specified in each request are appended to this structure, ensuring dynamic adaptability while preserving a standardized response format.
@@ -458,21 +458,21 @@ In response, `Easy Post` shares three types of rates, and in our integration, we
 
 ### Buy a Shipment API
 
-#### Purpose:
+#### Purpose
 
 The Buy a Shipment API is employed to share the rate ID of a specific shipment with EasyPost. This API facilitates the retrieval of a shipping label corresponding to the provided rate ID.
 
 #### Method
 
 `POST`
 
-#### Endpoint:
+#### Endpoint
 
 ```
 https://api.easypost.com/v2/shipments/shp_7383fa71161645259664060fb5c41c32/buy
 ```
 
-#### Request:
+#### Request
 
 <details>
 
@@ -492,7 +492,7 @@ https://api.easypost.com/v2/shipments/shp_7383fa71161645259664060fb5c41c32/buy
 | ----------------- | --------------- |
 | `id`              | `rateId`        |
 
-#### Response:
+#### Response
 
 {% hint style="info" %}
 `EasyPost` consistently structures its responses, maintaining a common format. Unique details specified in each request are appended to this structure, ensuring dynamic adaptability while preserving a standardized response format.
@@ -591,21 +591,21 @@ In this response, HotWax relies on two vital fields: `tracking_code` provides th
 
 ### Refund a Shipment API
 
-#### Purpose:
+#### Purpose
 
 The Refund a Shipment API is employed to void the shipping label generated for a specific shipment. This is useful in cases where a shipment needs to be canceled or rerouted.
 
 #### Method
 
 `POST`
 
-#### Endpoint:
+#### Endpoint
 
 ```
 https://api.easypost.com/v2/shipments/shp_a88f34ee108f4e82ab04b3570863f7fb/refund
 ```
 
-#### Request:
+#### Request
 
 <details>
 
@@ -619,7 +619,7 @@ https://api.easypost.com/v2/shipments/shp_a88f34ee108f4e82ab04b3570863f7fb/refun
 
 </details>
 
-#### Response:
+#### Response
 
 {% hint style="info" %}
 `EasyPost` consistently structures its responses, maintaining a common format. Unique details specified in each request are appended to this structure, ensuring dynamic adaptability while preserving a standardized response format.
@@ -824,6 +824,9 @@ These three APIs form the core of the integration, allowing HotWax to seamlessly
 
 ```
 - https://www.easypost.com/docs/api#create-a-shipment
+
 - https://www.easypost.com/docs/api#buy-a-shipment
+
 - https://www.easypost.com/docs/api#refund-a-shipment
+
 ```

documents/additional-integrations/loop/loop-exchanges.md

@@ -4,6 +4,7 @@ description: >-
 ---
 
 # Exchanges
+
 An exchange refers to a transaction in which a customer returns a purchased item and, instead of receiving a refund or store credit, opts to swap the returned item for a different product.
 
 ## Data Flow
@@ -22,7 +23,6 @@ The downloaded exchange orders are then brokered to the optimal fulfillment loca
 
 These exchange orders are also synchronized to NetSuite for further processing. Learn more about [synchronization of exchange orders from HotWax Commerce to NetSuite ERP.](https://docs.hotwax.co/documents/v/learn-netsuite/integration-flows/exchanges#README)
 
-
 ### Synchronize POS Exchanges to HotWax Commerce
 
 POS exchange sales are similar to other POS sales as both the transactions recorded in Shopify POS. POS exchange sales created in Shopify POS are imported into HotWax Commerce just like regular POS sales.

documents/additional-integrations/loop/loop-online.md

@@ -169,17 +169,17 @@ With this setup, after HotWax restocks the returned inventory from NetSuite duri
 
 When a customer opts for an exchange through Loop, a new exchange order is automatically created in Shopify once the return is closed in Loop. HotWax Commerce downloads these exchange orders from Shopify as regular orders and syncs them to NetSuite. Here's how different exchange scenarios are handled:
 
-#### 1. When the exchange order total is less than the original order:
+#### 1. When the exchange order total is less than the original order
 
 * Loop automatically refunds the customer for the price difference and creates a new exchange order in Shopify.
 * HotWax’s Integration Platform captures this refund data and processes it as discussed earlier, transforming it for NetSuite without additional steps.
 
-#### 2. When the exchange is for an item of equal value:
+#### 2. When the exchange is for an item of equal value
 
 * The process is straightforward, with no need for special handling.
 * The return and exchange data are transformed and synced to NetSuite, as previously discussed.
 
-#### 3. When the exchange is for an item of higher value (Upsell):
+#### 3. When the exchange is for an item of higher value (Upsell)
 
 * Loop includes attribution in the Shopify order notes, indicating that the new exchange order involves an upsell.
 * HotWax recognizes this attribution and processes the order accordingly.
@@ -193,13 +193,13 @@ Suppose a customer initiates a return for a $100 item and chooses to exchange it
 
 Retailers' return policies can vary, ranging from one to several months. To accommodate future returns, HotWax imports historical orders from Shopify. However, some retailers accept returns for orders placed over a year ago. If a retailer starts using HotWax Commerce within that year and lacks historical orders in the OMS, here’s how HotWax handles such cases:
 
-#### 1. Matching Shopify and NetSuite order IDs:
+#### 1. Matching Shopify and NetSuite order IDs
 
 * When return data is received from Loop, HotWax’s Integration Platform first checks the Shopify order ID in the OMS.
 * If a corresponding NetSuite order ID is found, the return process proceeds without interruptions.
 * The RMA is created in NetSuite and linked to the original sales order, maintaining consistency in data and workflows.
 
-#### 2. Fetching older orders from NetSuite:
+#### 2. Fetching older orders from NetSuite
 
 * In some cases, older orders may not be imported into the OMS, but the corresponding records still exist in NetSuite.
 * When no matching NetSuite order ID is found in the OMS, HotWax’s Integration Platform runs a search query in NetSuite using the Shopify order ID to locate the original sales order details.\
@@ -219,7 +219,7 @@ Since NetSuite already has the return order data from the Integration Platform,
 
 Customers who live near a brick-and-mortar store or those who prefer to get instant refunds opt for returning their purchases directly in-store.
 
-#### Scenarios where POS returns are accepted:
+#### Scenarios where POS returns are accepted
 
 * **Buy In-Store Return In-Store (BISRIS):** Customers return their in-store purchases to a nearby store location.
 * **Buy Online Return In-Store (BORIS):** Customers directly return their online purchases to a nearby store location.