fix: resolve HTTP links, double slash path and case mismatch in docs#1673
fix: resolve HTTP links, double slash path and case mismatch in docs#1673harshmahajan7 wants to merge 1 commit intohotwax:user-guides-pubfrom
Conversation
- Fix HTTP to HTTPS for job-manager.hotwax.io links (2 files) - Fix double slash // in retail-operations workflow path - Fix case mismatch: productStore-settings.md -> productstore-settings.md in SUMMARY.md
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request fixes a malformed internal link, updates a file reference to lowercase, and upgrades several URLs from HTTP to HTTPS. The review feedback identifies opportunities to further align the documentation with the style guide by using descriptive hyperlink text instead of raw URLs, ensuring parallel grammatical structure, and applying proper capitalization and backtick formatting for job names.
| Online ATP = QOH - (Reserved quantities + Safety stock + Threshold + Orders in brokering queue + Excluded facilities' ATP) | ||
|
|
||
| For each store that allows online fulfillment, HotWax Commerce calculates the Online ATP that is available to sell and synchronize the inventory with Shopify through [Hard Sync and \`Update recent inventory changes jobs](/documents/retail-operations//workflow/job-workflows/inventory). | ||
| For each store that allows online fulfillment, HotWax Commerce calculates the Online ATP that is available to sell and synchronize the inventory with Shopify through [Hard Sync and \`Update recent inventory changes jobs](/documents/retail-operations/workflow/job-workflows/inventory). |
There was a problem hiding this comment.
The link text contains a stray escaped backtick and the sentence lacks parallel structure ("calculates" vs "synchronize"). Additionally, job names should be capitalized as proper nouns and enclosed in backticks per the style guide. Pruning "that is" also improves clarity and conciseness.
| For each store that allows online fulfillment, HotWax Commerce calculates the Online ATP that is available to sell and synchronize the inventory with Shopify through [Hard Sync and \`Update recent inventory changes jobs](/documents/retail-operations/workflow/job-workflows/inventory). | |
| For each store that allows online fulfillment, HotWax Commerce calculates the Online ATP available to sell and synchronizes the inventory with Shopify through the [`Hard Sync` and `Update Recent Inventory Changes` jobs](/documents/retail-operations/workflow/job-workflows/inventory). |
| To initiate the import of products from Shopify, a crucial step before importing other data, follow these steps using the Initial Load page in the Job Manager app: | ||
|
|
||
| 1. Visit [job-manager.hotwax.io](http://job-manager.hotwax.io). | ||
| 1. Visit [job-manager.hotwax.io](https://job-manager.hotwax.io). |
There was a problem hiding this comment.
According to the style guide, hyperlinks should be applied to descriptive text rather than using the raw URL or hostname as the link text.
| 1. Visit [job-manager.hotwax.io](https://job-manager.hotwax.io). | |
| 1. Visit [Job Manager](https://job-manager.hotwax.io). |
References
- Add hyperlinks over text, not as raw URLs. (link)
| **To import orders in HotWax Commerce, follow these steps:** | ||
|
|
||
| 1. Visit [job-manager.hotwax.io](http://job-manager.hotwax.io). | ||
| 1. Visit [job-manager.hotwax.io](https://job-manager.hotwax.io). |
There was a problem hiding this comment.
According to the style guide, hyperlinks should be applied to descriptive text rather than using the raw URL or hostname as the link text.
| 1. Visit [job-manager.hotwax.io](https://job-manager.hotwax.io). | |
| 1. Visit [Job Manager](https://job-manager.hotwax.io). |
References
- Add hyperlinks over text, not as raw URLs. (link)
harshmahajan7
changed the title
1 participant
Summary
This PR fixes 3 issues found during a full automated scan of 492 markdown files in the
documents/directory.Changes Made
learn-shopify/initial-sync/README.mdhttp://→https://forjob-manager.hotwax.iolearn-shopify/initial-sync/import-orders.mdhttp://→https://forjob-manager.hotwax.iohow-to-guides/configure-store-fulfillment.md//in workflow pathnetsuite-deployment/SUMMARY.mdproductStore-settings.md→productstore-settings.mdRemaining Issues
4 broken relative links (missing files) are tracked in issue #1676 and need content decisions from maintainers:
learn-hotwax-oms/README.md— 3 broken links (packing slips, pre-orders, safety stock)how-to-guides/configure-store-fulfillment.md— missing page forconfigure-fulfillment-capacity