Fix spelling and capitalization inconsistencies for NetSuite and HotWax#1675
Fix spelling and capitalization inconsistencies for NetSuite and HotWax#1675dushyantmehta99 wants to merge 2 commits intohotwax:user-guides-pubfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates documentation across several files to correct typos, improve grammar, and standardize branding for NetSuite and HotWax Commerce. Key changes include fixing the casing of JSON and NetSuite, as well as refining punctuation. The review feedback highlights several style guide violations, specifically the requirement to use backticks for UI elements like "Bill to" and "ExternalID" instead of escaped quotes. Additionally, the feedback recommends properly introducing the "Available to Promise" (ATP) acronym, removing double spaces after punctuation, and stripping unnecessary backslashes from Markdown and HTML attributes to improve source readability.
| #### Check Customer ID | ||
|
|
||
| 1. Click on the customer name in the "Bill to" section. | ||
| 1. Click on the customer name in the \"Bill to\" section. |
There was a problem hiding this comment.
UI elements like "Bill to" should be formatted with backticks instead of escaped quotation marks. This improves readability and adheres to the style guide.
| 1. Click on the customer name in the \"Bill to\" section. | |
| 1. Click on the customer name in the `Bill to` section. |
References
- In documentation or internal guides, use backticks to format UI elements such as button names, labels, or page titles. (link)
| #### Check Customer Name and Email | ||
|
|
||
| 1. In the "Bill to" section, verify the customer's name contains any special characters. | ||
| 1. In the \"Bill to\" section, verify the customer's name contains any special characters. |
There was a problem hiding this comment.
UI elements like "Bill to" should be formatted with backticks. Additionally, remove the unnecessary backslashes which hinder Markdown readability.
| 1. In the \"Bill to\" section, verify the customer's name contains any special characters. | |
| 1. In the `Bill to` section, verify the customer's name contains any special characters. |
References
- In documentation or internal guides, use backticks to format UI elements such as button names, labels, or page titles. (link)
| 2. Navigate to the order view page | ||
| 3. In the “Payment Terms and Preferences” section, verify if preferences are set. | ||
| Confirm if the payment information is available in Shopify by checking the [`Order JSON data imported`](https://docs.hotwax.co/documents/v/retail-operations/workflow/data-manager/troubleshooting/shopify-mdm) in OMS. you can verify this on the Shopify order MDM | ||
| Confirm if the payment information is available in Shopify by checking the [`Order JSON data imported`](https://docs.hotwax.co/documents/v/retail-operations/workflow/data-manager/troubleshooting/shopify-mdm) in OMS. You can verify this on the Shopify order MDM |
There was a problem hiding this comment.
Avoid using double spaces after punctuation. Use a single space only to maintain consistency across documentation.
| Confirm if the payment information is available in Shopify by checking the [`Order JSON data imported`](https://docs.hotwax.co/documents/v/retail-operations/workflow/data-manager/troubleshooting/shopify-mdm) in OMS. You can verify this on the Shopify order MDM | |
| Confirm if the payment information is available in Shopify by checking the [`Order JSON data imported`](https://docs.hotwax.co/documents/v/retail-operations/workflow/data-manager/troubleshooting/shopify-mdm) in OMS. You can verify this on the Shopify order MDM |
References
- Never leave two spaces between words or after punctuation. One space only. (link)
|
|
||
| 1. Log in to HotWax Commerce. | ||
| 2. Navigate to the order view page and click "ExternalID." This will redirect you to the Shopify admin page. | ||
| 2. Navigate to the order view page and click \"ExternalID.\" This will redirect you to the Shopify admin page. |
There was a problem hiding this comment.
"ExternalID" is a UI element and should be formatted with backticks. Note that the trailing period should be placed outside the backticks for clarity.
| 2. Navigate to the order view page and click \"ExternalID.\" This will redirect you to the Shopify admin page. | |
| 2. Navigate to the order view page and click `ExternalID`. This will redirect you to the Shopify admin page. |
References
- In documentation or internal guides, use backticks to format UI elements such as button names, labels, or page titles. (link)
| # Introduction | ||
|
|
||
| The integration between HotWax Commerce and Shopify simplifies the process for retailers to synchronize their "available to promise" inventory from HotWax Commerce to Shopify. It also allows Shopify orders to be routed to either the warehouse or store for fast fulfillment. Finally, the integration can update Shopify with tracking details for orders. | ||
| The integration between HotWax Commerce and Shopify simplifies the process for retailers to synchronize their \"available to promise\" inventory from HotWax Commerce to Shopify. It also allows Shopify orders to be routed to either the warehouse or store for fast fulfillment. Finally, the integration can update Shopify with tracking details for orders. |
There was a problem hiding this comment.
Industry terms like "Available to Promise" should use standard quotation marks without backslashes. Additionally, per the style guide, the first mention of a term should include its acronym in parentheses.
| The integration between HotWax Commerce and Shopify simplifies the process for retailers to synchronize their \"available to promise\" inventory from HotWax Commerce to Shopify. It also allows Shopify orders to be routed to either the warehouse or store for fast fulfillment. Finally, the integration can update Shopify with tracking details for orders. | |
| The integration between HotWax Commerce and Shopify simplifies the process for retailers to synchronize their "Available to Promise" (ATP) inventory from HotWax Commerce to Shopify. It also allows Shopify orders to be routed to either the warehouse or store for fast fulfillment. Finally, the integration can update Shopify with tracking details for orders. |
References
- The first time a term appears, write the full term followed by the acronym in parentheses. (link)
| The integration between HotWax Commerce and Shopify simplifies the process for retailers to synchronize their \"available to promise\" inventory from HotWax Commerce to Shopify. It also allows Shopify orders to be routed to either the warehouse or store for fast fulfillment. Finally, the integration can update Shopify with tracking details for orders. | ||
|
|
||
| Once the product and order data are synchronized from Shopify to HotWax Commerce, and the "available to promise" inventory data is synchronized from HotWax Commerce to Shopify, you can begin using HotWax Commerce. | ||
| Once the product and order data are synchronized from Shopify to HotWax Commerce, and the \"available to promise\" inventory data is synchronized from HotWax Commerce to Shopify, you can begin using HotWax Commerce. |
There was a problem hiding this comment.
Use the acronym ATP for subsequent mentions of the term within the same document and remove unnecessary backslashes.
| Once the product and order data are synchronized from Shopify to HotWax Commerce, and the \"available to promise\" inventory data is synchronized from HotWax Commerce to Shopify, you can begin using HotWax Commerce. | |
| Once the product and order data are synchronized from Shopify to HotWax Commerce, and the ATP inventory data is synchronized from HotWax Commerce to Shopify, you can begin using HotWax Commerce. |
References
- On later mentions within the same document, use the acronym alone. (link)
| ## What Will Be Synced Between Shopify and HotWax Commerce | ||
|
|
||
| <figure><img src=".gitbook/assets/shopify-hotwax-data-flow.png" alt=""><figcaption><p>Flow of Data Between Shopify and HotWax Commerce</p></figcaption></figure> | ||
| <figure><img src=\".gitbook/assets/shopify-hotwax-data-flow.png\" alt=\"\"><figcaption><p>Flow of Data Between Shopify and HotWax Commerce</p></figcaption></figure> |
There was a problem hiding this comment.
Backslashes are not required for HTML attributes in Markdown and negatively impact the source file's readability.
| <figure><img src=\".gitbook/assets/shopify-hotwax-data-flow.png\" alt=\"\"><figcaption><p>Flow of Data Between Shopify and HotWax Commerce</p></figcaption></figure> | |
| <figure><img src=".gitbook/assets/shopify-hotwax-data-flow.png" alt=""><figcaption><p>Flow of Data Between Shopify and HotWax Commerce</p></figcaption></figure> |
| **Products:** To ensure that orders for all products in Shopify can be fulfilled, HotWax Commerce initially synchronizes all the products. Afterward, any newly added products by a merchandiser in Shopify are synced with HotWax Commerce at regular intervals. During this synchronization process, important product information including Shopify ID, SKU, UPC, product images, and additional details such as product names and features are also synced. Any updates made to product details are also synchronized in HotWax Commerce to provide merchants with the latest product information. Read [here](shopify-integration/products/) to learn how products are synced from Shopify to HotWax Commerce. | ||
|
|
||
| **Inventory**: When integrating HotWax Commerce and Shopify, HotWax Commerce acts as the master of inventory availability. HotWax Commerce has the capability to integrate with various systems within the Shopify retailer’s tech stack, allowing for the calculation of "sellable inventory". This information is then synchronized to Shopify at regular intervals. For additional information on how HotWax Commerce manages and synchronizes sellable inventory to Shopify, check out [here](shopify-integration/inventory/) | ||
| **Inventory**: When integrating HotWax Commerce and Shopify, HotWax Commerce acts as the master of inventory availability. HotWax Commerce has the capability to integrate with various systems within the Shopify retailer’s tech stack, allowing for the calculation of \"sellable inventory\". This information is then synchronized to Shopify at regular intervals. For additional information on how HotWax Commerce manages and synchronizes sellable inventory to Shopify, check out [here](shopify-integration/inventory/). |
There was a problem hiding this comment.
Remove unnecessary backslashes from the phrase "sellable inventory" to maintain standard Markdown formatting.
| **Inventory**: When integrating HotWax Commerce and Shopify, HotWax Commerce acts as the master of inventory availability. HotWax Commerce has the capability to integrate with various systems within the Shopify retailer’s tech stack, allowing for the calculation of \"sellable inventory\". This information is then synchronized to Shopify at regular intervals. For additional information on how HotWax Commerce manages and synchronizes sellable inventory to Shopify, check out [here](shopify-integration/inventory/). | |
| **Inventory**: When integrating HotWax Commerce and Shopify, HotWax Commerce acts as the master of inventory availability. HotWax Commerce has the capability to integrate with various systems within the Shopify retailer’s tech stack, allowing for the calculation of "sellable inventory". This information is then synchronized to Shopify at regular intervals. For additional information on how HotWax Commerce manages and synchronizes sellable inventory to Shopify, check out [here](shopify-integration/inventory/). |
… into standard naming PR
Description
This PR resolves the spelling and capitalization inconsistencies identified in Issue #1672. It also includes a batch of documentation improvements from the initial audit, including relative link conversions and further typo corrections.
Changes Made
order-do-not-sync.md.SUMMARY.md.order-updates.md.Closes #1672