docs(learn-netsuite): Fix spelling errors and broken internal link#1677
Open
devshex wants to merge 1 commit intohotwax:user-guides-pubfrom
Open
docs(learn-netsuite): Fix spelling errors and broken internal link#1677devshex wants to merge 1 commit intohotwax:user-guides-pubfrom
devshex wants to merge 1 commit intohotwax:user-guides-pubfrom
Conversation
- Fixed typo 'invenotry' -> 'inventory' in cycle-count.md (line 129) - Fixed typo 'confimration' -> 'confirmation' in returns/README.md (line 25) - Fixed typo 'desginated' -> 'designated' in giftcard-orders.md (line 93) - Fixed typo 'keesp' -> 'keeps' in order-approval.md (line 136) - Fixed broken link case-sensitivity: productStore-settings.md -> productstore-settings.md in SUMMARY.md (line 15)
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request corrects several typographical errors and formatting issues across the NetSuite integration documentation, including fixes for "inventory", "confirmation", and "designated". Review feedback suggests further improvements to align with the brand voice and style guide, such as adding articles for better flow, replacing "synchronization" with "syncing", and correcting "a/an" usage based on pronunciation.
| When variances are tracked using variance locations in NetSuite, variances logged by HotWax Commerce are actually registered as an Inventory Transfer from the affected store location to the variance location. For example, if a store wants to damage out 5 units of a product, they’d log an inventory transfer of that product from their store to the Damaged location. This reduces the inventory from the store and increments that inventory at the Damaged location. Now retailers can use this movement to analyze which facilities are logging damaged inventory at higher rates than others and potentially track down operational and planning issues. | ||
|
|
||
| The CSV file containing inventory item variance feed is also stored in the designated SFTP location for NetSuite as invenotry transfer file: | ||
| The CSV file containing inventory item variance feed is also stored in the designated SFTP location for NetSuite as inventory transfer file: |
Contributor
There was a problem hiding this comment.
The sentence is missing articles, which makes it read somewhat unnaturally. Adding "the" and "an" improves the flow and aligns with the brand voice of being "simple and human."
Suggested change
| The CSV file containing inventory item variance feed is also stored in the designated SFTP location for NetSuite as inventory transfer file: | |
| The CSV file containing the inventory item variance feed is also stored in the designated SFTP location for NetSuite as an inventory transfer file: |
References
- HotWax’s brand voice should be simple and human, using natural and conversational language. (link)
| A scheduled job in HotWax Commerce downloads both physical and digital gift card orders from the eCommerce platform like Shopify. | ||
|
|
||
| Learn more about[ gift card orders synchronization to HotWax Commerce](/documents/learn-shopify/shopify-integration/orders/giftcards-download) | ||
| Learn more about [gift card orders synchronization to HotWax Commerce](/documents/learn-shopify/shopify-integration/orders/giftcards-download) |
Contributor
There was a problem hiding this comment.
The term "synchronization" is considered jargon and is specifically advised against in the style guide. Using "syncing" makes the content more concise and easier to scan.
Suggested change
| Learn more about [gift card orders synchronization to HotWax Commerce](/documents/learn-shopify/shopify-integration/orders/giftcards-download) | |
| Learn more about [syncing gift card orders to HotWax Commerce](/documents/learn-shopify/shopify-integration/orders/giftcards-download) |
References
- Favor plain, recognizable language over jargon. Use 'sync' instead of 'synchronization'. (link)
| ### Activation of Gift Cards | ||
|
|
||
| A scheduled SuiteScript in NetSuite generates a CSV file containing gift card items, their assigned serial numbers, and values corresponding to the gift card orders. The generated CSV is then placed at an desginated SFTP location. | ||
| A scheduled SuiteScript in NetSuite generates a CSV file containing gift card items, their assigned serial numbers, and values corresponding to the gift card orders. The generated CSV is then placed at an designated SFTP location. |
Contributor
There was a problem hiding this comment.
The article "an" should be replaced with "a" because "designated" begins with a consonant sound. The choice of article depends on pronunciation.
Suggested change
| A scheduled SuiteScript in NetSuite generates a CSV file containing gift card items, their assigned serial numbers, and values corresponding to the gift card orders. The generated CSV is then placed at an designated SFTP location. | |
| A scheduled SuiteScript in NetSuite generates a CSV file containing gift card items, their assigned serial numbers, and values corresponding to the gift card orders. The generated CSV is then placed at a designated SFTP location. |
References
- Use 'a' or 'an' depending on pronunciation, not spelling. (link)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This change addresses quality issues identified during a documentation audit of the
learn-netsuitesection. A total of 4 spelling errors and 1 broken internal link have been corrected across 5 files. All modifications are strictly scoped todocuments/learn-netsuite/and its sub-directories. No other documentation sections were altered.Spelling Corrections
integration-flows/cycle-count.mdinvenotryinventoryintegration-flows/returns/README.mdconfimrationconfirmationintegration-flows/sales-order/giftcard-orders.mddesginateddesignatedintegration-flows/sales-order/order-approval.mdkeespkeepsBroken Link Fix
netsuite-deployment/SUMMARY.mdproductStore-settings.mdwith an uppercaseS, which does not match the actual filenameproductstore-settings.md. File systems and GitHub resolve paths case-sensitively, causing a404for this link.productstore-settings.md