Refine HSM template documentation formatting#576
Conversation
Updated formatting and clarified instructions for HSM template creation.
📝 WalkthroughWalkthroughDocumentation updates to the HSM Templates guide including formatting refinements, addition of guidance for Wait for Response node requirement, minor rewording of field descriptions, and reorganization of sections for improved readability. Changes
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly Related PRs
Suggested Reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
🚀 Deployed on https://deploy-preview-576--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/4. Product Features/06. HSM Templates.md (1)
136-136:⚠️ Potential issue | 🟡 MinorTypo: "Suffi- x" should be "Suffix".
The word "Suffix" is broken by a stray hyphen and space, likely a copy-paste artifact.
✏️ Proposed fix
-- Sample Suffi- x: 12345 (so the full link becomes `https://xyz.org/report/12345`) +- Sample Suffix: 12345 (so the full link becomes `https://xyz.org/report/12345`)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/4`. Product Features/06. HSM Templates.md at line 136, Fix the typo in the text snippet "Sample Suffi- x: 12345 (so the full link becomes `https://xyz.org/report/12345`)" by removing the stray hyphen and space so it reads "Sample Suffix: 12345 (so the full link becomes `https://xyz.org/report/12345`)"; locate the exact string in the HSM Templates document and replace "Suffi- x" with "Suffix".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/4`. Product Features/06. HSM Templates.md:
- Line 317: Fix the subject-verb agreement in the sentence "Here's what each
column represent in the sheet." by changing "represent" to "represents" so it
reads "Here's what each column represents in the sheet." Update this exact
sentence in the "3. Fill in details for templates in rows." section to ensure
grammatical correctness.
- Around line 90-91: The "Call to action buttons" list item has incorrect
indentation for its nesting level; update the markdown so the bullet "- Call
to action buttons: Add a Call to Action (CTA) button..." uses two spaces of
indentation instead of one (aligning with sibling list items) to satisfy MD005
and keep consistent nesting for that list item.
- Around line 104-105: Replace the sentence "Please Note : HSM templates support
upto 2 URL buttons 1 Phone number button" with a grammatically correct version:
change "upto" to "up to", normalize spacing and capitalization around the colon,
add a conjunction/separator between items, and clarify "Phone number" casing;
e.g. "Please note: HSM templates support up to 2 URL buttons and 1 phone-number
button." Ensure the original text snippet is updated exactly where it appears.
- Around line 28-29: Fix the missing space in the sentence "Please Note: The
next node after an HSM must always be Wait for Response.This..." by changing it
to "Response. This" and move this bullet from the "When to Use HSM Templates"
section to the "How to use HSM Templates in your flows" section (near the
explanatory flow-builder guidance) so the flow constraint for the sentence
"Please Note: The next node after an HSM must always be Wait for Response." is
more discoverable.
- Line 62: Summary: The term "drop down" used as a compound modifier should be
hyphenated. Replace the phrase "becomes a drop down" with "becomes a drop-down"
in the sentence containing `Element Name` to correctly hyphenate the compound
modifier and maintain consistent style in the HSM template documentation.
---
Outside diff comments:
In `@docs/4`. Product Features/06. HSM Templates.md:
- Line 136: Fix the typo in the text snippet "Sample Suffi- x: 12345 (so the
full link becomes `https://xyz.org/report/12345`)" by removing the stray hyphen
and space so it reads "Sample Suffix: 12345 (so the full link becomes
`https://xyz.org/report/12345`)"; locate the exact string in the HSM Templates
document and replace "Suffi- x" with "Suffix".
| - Please Note: The next node after an HSM must always be Wait for Response.This ensures the system waits for user interaction before continuing the flow. | ||
|
|
There was a problem hiding this comment.
Missing space between sentences + consider relocating this note.
"Response.This" is missing a space. Additionally, this bullet is placed under "When to Use HSM Templates" but it describes a flow-builder constraint — it would be more discoverable under "How to use HSM Templates in your flows" (around Line 187).
✏️ Proposed fix (spacing only)
- - Please Note: The next node after an HSM must always be Wait for Response.This ensures the system waits for user interaction before continuing the flow.
+ - **Please Note:** The next node after an HSM must always be **Wait for Response**. This ensures the system waits for user interaction before continuing the flow.🧰 Tools
🪛 LanguageTool
[style] ~28-~28: The adverb ‘always’ is usually put between ‘be’ and ‘Wait’.
Context: ...e Note: The next node after an HSM must always be Wait for Response.This ensures the system wa...
(ADVERB_WORD_ORDER)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/06. HSM Templates.md around lines 28 - 29, Fix the
missing space in the sentence "Please Note: The next node after an HSM must
always be Wait for Response.This..." by changing it to "Response. This" and move
this bullet from the "When to Use HSM Templates" section to the "How to use HSM
Templates in your flows" section (near the explanatory flow-builder guidance) so
the flow constraint for the sentence "Please Note: The next node after an HSM
must always be Wait for Response." is more discoverable.
| c.`Translate existing HSM` - Select this if the HSM template you are trying to apply has a language variant of an existing HSM template in a different language. If not then no need to enable it. | ||
|
|
||
| d. `Element Name` - Provide a title for WABA namespace for the HSM template. Incase the translate existing HSM is selected, this field becomes a drop down. From the list select the element name of the HSM template for which the language variant is being applied. | ||
| d.`Element Name` - Provide a title for WABA namespace for the HSM template. Incase the translate existing HSM is selected, this field becomes a drop down. From the list select the element name of the HSM template for which the language variant is being applied. |
There was a problem hiding this comment.
Hyphenate "drop-down".
"drop down" used as a compound modifier before a noun should be hyphenated.
✏️ Proposed fix
- c.`Translate existing HSM` - Select this if the HSM template you are trying to apply has a language variant of an existing HSM template in a different language. If not then no need to enable it.
- d.`Element Name` - Provide a title for WABA namespace for the HSM template. Incase the translate existing HSM is selected, this field becomes a drop down. From the list select the element name of the HSM template for which the language variant is being applied.
+ d.`Element Name` - Provide a title for WABA namespace for the HSM template. In case the translate existing HSM is selected, this field becomes a drop-down. From the list select the element name of the HSM template for which the language variant is being applied.🧰 Tools
🪛 LanguageTool
[grammar] ~62-~62: Use a hyphen to join words.
Context: ...M is selected, this field becomes a drop down. From the list select the element n...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/06. HSM Templates.md at line 62, Summary: The term
"drop down" used as a compound modifier should be hyphenated. Replace the phrase
"becomes a drop down" with "becomes a drop-down" in the sentence containing
`Element Name` to correctly hyphenate the compound modifier and maintain
consistent style in the HSM template documentation.
| - Call to action buttons: Add a Call to Action (CTA) button in an HSM (template) message when the recipient is expected to take a specific action directly from the message. | ||
|
|
There was a problem hiding this comment.
Fix inconsistent list-item indentation (MD005).
markdownlint reports that the "Call to action buttons" bullet at Line 90 uses 1 space of indentation where 2 spaces are expected at this nesting level, causing MD005.
✏️ Proposed fix
- - Call to action buttons: Add a Call to Action (CTA) button in an HSM (template) message when the recipient is expected to take a specific action directly from the message.
+ - Call to action buttons: Add a Call to Action (CTA) button in an HSM (template) message when the recipient is expected to take a specific action directly from the message.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Call to action buttons: Add a Call to Action (CTA) button in an HSM (template) message when the recipient is expected to take a specific action directly from the message. | |
| - Call to action buttons: Add a Call to Action (CTA) button in an HSM (template) message when the recipient is expected to take a specific action directly from the message. | |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 90-90: Inconsistent indentation for list items at the same level
Expected: 2; Actual: 1
(MD005, list-indent)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/06. HSM Templates.md around lines 90 - 91, The
"Call to action buttons" list item has incorrect indentation for its nesting
level; update the markdown so the bullet "- Call to action buttons: Add a Call
to Action (CTA) button..." uses two spaces of indentation instead of one
(aligning with sibling list items) to satisfy MD005 and keep consistent nesting
for that list item.
| - Please Note : HSM templates support upto 2 URL buttons 1 Phone number button | ||
|
|
There was a problem hiding this comment.
Fix "upto" and add missing punctuation/conjunction.
upto is not standard English — it should be two words: up to. The list of limits also omits a separator between the two items.
✏️ Proposed fix
- - Please Note : HSM templates support upto 2 URL buttons 1 Phone number button
+ - **Please Note:** HSM templates support up to 2 URL buttons and 1 Phone Number button.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/06. HSM Templates.md around lines 104 - 105,
Replace the sentence "Please Note : HSM templates support upto 2 URL buttons 1
Phone number button" with a grammatically correct version: change "upto" to "up
to", normalize spacing and capitalization around the colon, add a
conjunction/separator between items, and clarify "Phone number" casing; e.g.
"Please note: HSM templates support up to 2 URL buttons and 1 phone-number
button." Ensure the original text snippet is updated exactly where it appears.
|  | ||
|
|
||
| 3. Fill in details for templates in rows. Here's what each column represent in the sheet | ||
| 3. Fill in details for templates in rows. Here's what each column represent in the sheet. |
There was a problem hiding this comment.
Subject-verb agreement: "represent" → "represents".
"each column" is singular; the verb must be third-person singular.
✏️ Proposed fix
-3. Fill in details for templates in rows. Here's what each column represent in the sheet.
+3. Fill in details for templates in rows. Here's what each column represents in the sheet.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 3. Fill in details for templates in rows. Here's what each column represent in the sheet. | |
| 3. Fill in details for templates in rows. Here's what each column represents in the sheet. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/06. HSM Templates.md at line 317, Fix the
subject-verb agreement in the sentence "Here's what each column represent in the
sheet." by changing "represent" to "represents" so it reads "Here's what each
column represents in the sheet." Update this exact sentence in the "3. Fill in
details for templates in rows." section to ensure grammatical correctness.
2 participants
Updated formatting and clarified instructions for HSM template creation.
Summary by CodeRabbit