Fix typos, capitalization, and grammar in integrate-with-hotwax docs#1679
Fix typos, capitalization, and grammar in integrate-with-hotwax docs#1679pratham5816 wants to merge 1 commit intohotwax:user-guides-pubfrom
Conversation
…wax docs - Fix "Jsons" to "JSONs" in README.md - Fix missing comma: "APIs Data Feeds" to "APIs, Data Feeds" in README.md - Fix "update product" to "update products" (plural) in README.md - Fix "Hotwax" to "HotWax" in initial-api-authentication.md - Fix "Hotwax" to "HotWax" in soft-allocation.md - Fix duplicate word "for for" to "for" in returns-financial-feed.md - Fix "finanacial" to "financial" in returns-financial-feed.md - Fix "Howax" to "HotWax" in returns-financial-feed.md
There was a problem hiding this comment.
Code Review
This pull request addresses various typos, capitalization errors, and grammatical inconsistencies across the documentation, specifically standardizing the brand name to "HotWax". The review feedback points out several remaining violations of the HotWax Style Guide, such as the use of prohibited words like "leverage" and "ensure," the omission of the Oxford comma, and the use of em dashes. Corrective suggestions were provided for each instance to align the documentation with the required brand voice and formatting rules.
| # Introduction | ||
|
|
||
| HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to leverage them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs Data Feeds and detailed information on each API, including how to authenticate, make requests, and handle responses. | ||
| HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to leverage them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs, Data Feeds and detailed information on each API, including how to authenticate, make requests, and handle responses. |
There was a problem hiding this comment.
The word 'leverage' should be avoided according to the style guide. Additionally, an Oxford comma is missing before 'and' in the list of documentation aspects.
| HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to leverage them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs, Data Feeds and detailed information on each API, including how to authenticate, make requests, and handle responses. | |
| HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to use them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs, Data Feeds, and detailed information on each API, including how to authenticate, make requests, and handle responses. |
| ## How to generate a bearer token | ||
|
|
||
| Hotwax Commerce relies on robust security features provided by JWT (JSON Web Token) to ensure a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps: | ||
| HotWax Commerce relies on robust security features provided by JWT (JSON Web Token) to ensure a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps: |
There was a problem hiding this comment.
The word 'ensure' should be avoided according to the style guide. Consider using 'provide' or 'maintain' instead.
| HotWax Commerce relies on robust security features provided by JWT (JSON Web Token) to ensure a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps: | |
| HotWax Commerce relies on robust security features provided by JWT (JSON Web Token) to provide a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps: |
References
- Avoid using 'Ensure'. (link)
| ## Introduction | ||
|
|
||
| The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for finanacial reconciliation. The feed is transformed - by HotWax's intermediary systems - in a way that allow integrated third-party systems, such as the ERP systems, to ingest the generated data. | ||
| The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for financial reconciliation. The feed is transformed - by HotWax's intermediary systems - in a way that allow integrated third-party systems, such as the ERP systems, to ingest the generated data. |
There was a problem hiding this comment.
The verb 'allow' should be 'allows' to agree with the singular subject 'The feed'. Additionally, the style guide discourages using dashes to join ideas; removing them improves the flow and adherence to the guide.
| The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for financial reconciliation. The feed is transformed - by HotWax's intermediary systems - in a way that allow integrated third-party systems, such as the ERP systems, to ingest the generated data. | |
| The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for financial reconciliation. The feed is transformed by HotWax's intermediary systems in a way that allows integrated third-party systems, such as the ERP systems, to ingest the generated data. |
References
- Do not use em dashes (—) to join ideas or add emphasis. Use a comma or rewrite the sentence. (link)
| # Order Soft Allocation | ||
|
|
||
| Hotwax Commerce's Soft Allocation feature performs real-time eligibility checks for the items in a customer's shopping cart. By evaluating the list of items in the cart along with the destination zip code, Soft Allocation ensures compliance with predefined criteria set by retailers such as checking if all items can be shipped from one location. | ||
| HotWax Commerce's Soft Allocation feature performs real-time eligibility checks for the items in a customer's shopping cart. By evaluating the list of items in the cart along with the destination zip code, Soft Allocation ensures compliance with predefined criteria set by retailers such as checking if all items can be shipped from one location. |
There was a problem hiding this comment.
The word 'ensures' should be avoided according to the style guide. 'Verifies' or 'confirms' are better alternatives in this context.
| HotWax Commerce's Soft Allocation feature performs real-time eligibility checks for the items in a customer's shopping cart. By evaluating the list of items in the cart along with the destination zip code, Soft Allocation ensures compliance with predefined criteria set by retailers such as checking if all items can be shipped from one location. | |
| HotWax Commerce's Soft Allocation feature performs real-time eligibility checks for the items in a customer's shopping cart. By evaluating the list of items in the cart along with the destination zip code, Soft Allocation verifies compliance with predefined criteria set by retailers such as checking if all items can be shipped from one location. |
References
- Avoid using 'Ensure'. (link)
Description
This PR fixes typos, capitalization inconsistencies, and grammar issues found in the
integrate-with-hotwaxdocumentation.Changes Made
README.mdJsonsJSONsREADME.mdAPIs Data Feeds(missing comma)APIs, Data FeedsREADME.mdupdate product(missing plural)update productsapi/initial-api-authentication.mdHotwax CommerceHotWax Commercejourneys/brokering-and-allocation/soft-allocation.mdHotwax Commerce'sHotWax Commerce'sapi/returns/returns-financial-feed.mdfor for(duplicate word)forapi/returns/returns-financial-feed.mdfinanacialfinancialapi/returns/returns-financial-feed.mdHowaxHotWaxNo broken links found
All internal markdown links across the 64 files in
integrate-with-hotwaxresolve correctly.