Support for More Than 3 Quick Reply Buttons in HSM Templates

[priyanshu6238]

Summary by CodeRabbit

• Documentation
  • Updated HSM Templates guide (last updated Dec 2025) with reorganized creation/approval flow, clearer lifecycle, immutability after approval, and rejection handling.
  • Clarified fields and examples (element names, title, footer, variables), CTA/buttons guidance (Quick Replies up to 10), and static vs dynamic URL behavior.
  • Expanded multi-language/template workflow, bulk-apply/CSV details, and refreshed images/captions for consistency.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Updated HSM Templates documentation: reorganized creation/approval flow, extended Quick Reply support up to 10 items, clarified Static vs Dynamic URL and attachment terminology, expanded bulk‑apply and multi‑language workflows, replaced screenshots, and updated "Last Updated" to December 2025. No code or control‑flow changes.

Changes

Cohort / File(s)

Summary

Documentation and content overhaul docs/4. Product Features/06. HSM Templates.md

Large editorial restructure: updated "Last Updated" date and header formatting; reordered/renamed HSM creation fields (Element Name, Title, Message, Add Variable, Footer, Add Buttons); expanded Quick Replies to allow 4–10 items and clarified CTA/button behavior; standardized Static vs Dynamic URL terminology and examples; normalized Category/Attachment guidance and immutability notes; expanded multi‑language and bulk‑apply (CSV) workflows and rejection handling; swapped and relabeled images and alt text; many line‑level readability/formatting edits. No executable changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Single large documentation file with consistent editorial changes.
• Spot-check recommendations:
  • Quick Replies (items 4–10) and corresponding screenshots
  • Bulk‑apply CSV layout, field examples, and attachment handling
  • Static vs Dynamic URL examples and CTA/button labeling
  • Multi‑language workflow steps and immutability/approval text
  • Image replacements and alt text consistency

Possibly related issues

• Update Documentation — Support for More Than 3 Quick Reply Buttons in HSM Templates #516 — Matches change expanding Quick Reply support (from 3 to up to 10) and related UI/text updates.

Possibly related PRs

• Update 06. HSM Templates.md #453 — Overlaps on Static vs Dynamic URL examples and wording changes.
• Update and rename 06. Templates.md to 06. HSM Templates.md #422 — Directly related edits to the same HSM Templates doc (structure and images).
• Update HSM template documentation #396 — Overlaps on field reordering, bulk‑apply, multi‑language guidance, and image updates.

Suggested reviewers

• Fawas003
• SangeetaMishr
• mahajantejas

Poem

🐰 I hopped through lines and tuned each part,
Moved buttons, urls, and images with heart.
Quick Replies now stretch to ten,
Multilingual paths neat again,
A tiny rabbit's documentation art.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately captures the main feature enhancement discussed throughout the PR: expanding Quick Reply button support from 3 to 10 buttons in HSM Templates, which aligns with the documented changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch refactor/quick_reply_doc

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce0e674 and 0e24b00.

📒 Files selected for processing (1)

• docs/4. Product Features/06. HSM Templates.md (5 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/06. HSM Templates.md

[grammar] ~60-~60: 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)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/06. HSM Templates.md

88-88: Unordered list indentation
Expected: 0; Actual: 3

(MD007, ul-indent)

---

103-103: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (5)

docs/4. Product Features/06. HSM Templates.md (5)

1-1: Main heading added successfully.

The "HSM Templates" heading is properly positioned and formatted according to PR objectives.

---

83-83: Grammar corrections applied correctly.

The sentence now uses proper phrasing: "up to" (instead of "upto"), plural "buttons" (instead of "button"), and the correct preposition "in" (instead of "on").

---

317-323: Quick Reply expansion properly documented.

The addition of Quick Reply fields 4–10 is well-formatted and aligns with the PR objective to support more than 3 quick reply buttons. Each entry follows the consistent pattern of previous fields and clearly describes its role in the bulk apply CSV schema.

---

197-197: Flow usage screenshots updated.

The screenshots showing HSM Template selection in flows (Send Message action, HSM Template tab, variable selection) have been refreshed with December 2025 timestamps, addressing the prior concern about outdated UI visuals.

Also applies to: 201-201, 206-206

---

1-360: Comprehensive HSM Templates documentation update.

The document successfully expands support to 10 quick reply buttons, reorganizes template creation workflow, adds multi-language and bulk apply guidance, and updates screenshots to reflect the current UI. Structure and content flow are well-organized. The three linter issues (hyphenation at line 60, MD036 at line 103, MD007 at lines 79–97) are flagged separately and should be resolved to finalize the PR.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🚀 Deployed on https://deploy-preview-526--glific-docs.netlify.app

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd87519 and a8c4cef.

📒 Files selected for processing (1)

• docs/4. Product Features/06. HSM Templates.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/06. HSM Templates.md

[grammar] ~59-~59: 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)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/06. HSM Templates.md

95-95: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)

docs/4. Product Features/06. HSM Templates.md (1)

11-13: Comprehensive documentation improvements well-executed.

The reorganization and expansion of the HSM Templates guidance significantly enhance clarity and usability:

• Sub-items (a–n) in the template creation section are well-structured with concise descriptions for each field
• Enhanced explanations for URL handling (Static vs. Dynamic) with practical examples improve user understanding
• New Quick Reply entries (4–10) in the Bulk Apply section properly extend documentation for the expanded 10-button capability
• Inline images are strategically placed to visually support instructions
• Formatting and visual hierarchy improvements make the document easier to navigate

Also applies to: 49-152, 308-314

[Fawas003]

• The main heading ‘HSM Templates’ is missing.
• Update the Last Updated timestamp to December 2025.
• Update the following line, as it is incorrect, ‘Quick Replies is selected by default (Call to action’ is now selected by default in the dropdown).
• Add a screenshot showing how to add a button and select either Call to Action or Quick Reply.
• Update the screenshots for adding buttons, Call to Action, and Quick Reply, as the existing ones are based on the old UI.
• Update the screenshot for adding the ‘HSM Templates’ node in the flow editor (current one uses the old UI).

[priyanshu6238]

• The main heading ‘HSM Templates’ is missing.
• Update the Last Updated timestamp to December 2025.
• Update the following line, as it is incorrect, ‘Quick Replies is selected by default (Call to action’ is now selected by default in the dropdown).
• Add a screenshot showing how to add a button and select either Call to Action or Quick Reply.
• Update the screenshots for adding buttons, Call to Action, and Quick Reply, as the existing ones are based on the old UI.
• Update the screenshot for adding the ‘HSM Templates’ node in the flow editor (current one uses the old UI).

@Fawas003 which header you are taking about here?

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (2)

docs/4. Product Features/06. HSM Templates.md (2)

59-59: Fix hyphenation: "drop down" → "drop-down".

This issue was flagged in a previous review and remains unresolved.

-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.
+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.

---

95-95: Convert bold text to markdown heading (MD036).

This issue was flagged in a previous review and remains unresolved. Use a level-3 heading instead of bold emphasis.

-**Static URL**
+### Static URL

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8c4cef and 63efb74.

📒 Files selected for processing (1)

• docs/4. Product Features/06. HSM Templates.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/06. HSM Templates.md

[grammar] ~59-~59: 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)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/06. HSM Templates.md

95-95: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (2)

docs/4. Product Features/06. HSM Templates.md (2)

77-77: Verify default button type matches updated UI behavior.

The PR objectives request correcting the statement that "Call to Action is now selected by default in the dropdown," but Line 77 still states "Quick Replies is selected by default." Clarify whether this line should be updated to reflect the new default behavior.

If Call to Action is now the default, update Line 77:

-    - Quick Replies is selected by default, which allows adding up to 10 buttons.
+    - Call to Action is selected by default. Alternatively, Quick Replies can be selected to add up to 10 buttons.

Please confirm the current default behavior with the product team before making this change.

---

308-314: Quick Reply 4–10 expansion approved.

The additions of Quick Reply 4 through Quick Reply 10 (lines 308–314) correctly extend support for more than 3 quick reply buttons, directly addressing the PR's stated objective. The formatting and structure are consistent with the existing Quick Reply 1–3 entries.

[priyanshu6238]

• The main heading ‘HSM Templates’ is missing.
• Update the Last Updated timestamp to December 2025.
• Update the following line, as it is incorrect, ‘Quick Replies is selected by default (Call to action’ is now selected by default in the dropdown).
• Add a screenshot showing how to add a button and select either Call to Action or Quick Reply.
• Update the screenshots for adding buttons, Call to Action, and Quick Reply, as the existing ones are based on the old UI.
• Update the screenshot for adding the ‘HSM Templates’ node in the flow editor (current one uses the old UI).

@Fawas003 which header you are taking about here?

Is not there before ,but it fine added now.

[priyanshu6238]

@CodeRabbit review last two commit

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the last two commits on the PR branch
git log --oneline -2 origin/refactor/quick_reply_doc

# Get detailed information about the last two commits
git log -2 --format=fuller origin/refactor/quick_reply_doc

# Show the diff for the last two commits
git log -2 --stat origin/refactor/quick_reply_doc

# Get the actual changes in the last two commits
git diff origin/refactor/quick_reply_doc~2..origin/refactor/quick_reply_doc

Length of output: 882

---

🏁 Script executed:

#!/bin/bash
# Fetch the PR branch
gh pr checkout 526

# Get the last two commits
git log --oneline -2

# Get detailed information about the last two commits
git log -2 --format=fuller

# Show the diff for the last two commits compared to their parent
git log -2 --patch

Length of output: 2837

---

🏁 Script executed:

#!/bin/bash
# Check the current state of the file to see the timestamp and other content
cat "docs/4. Product Features/06.  HSM Templates.md" | head -20

# Check for any references to flow editor screenshots in the file
rg -n "flow editor|flow-editor" "docs/4. Product Features/06.  HSM Templates.md"

# Check the entire Last Updated section
rg -n -A2 "Last Updated" "docs/4. Product Features/06.  HSM Templates.md"

Length of output: 1352

---

🏁 Script executed:

#!/bin/bash
# Search for flow editor or flow-related content to see if there's a screenshot that needs updating
rg -n -C5 -i "flow" "docs/4. Product Features/06.  HSM Templates.md"

# Also check for any other old UI screenshots that might need updating
rg -n "!\[.*\]|<img" "docs/4. Product Features/06.  HSM Templates.md" | head -30

Length of output: 6685

---

@priyanshu6238, great progress on the last two commits! Here's my review:

✅ What's been addressed:

1. Main heading added - "# HSM Templates" is now present at the top of the document
2. Timestamp updated - Shows "December 2025" correctly
3. Default dropdown corrected - The text now accurately states "Call to Action is selected by default"
4. New screenshots added - Good quality screenshots showing the dropdown selection and Quick Reply button options

🔍 Issues found in the recent changes:

Line 82 has a grammar issue:

- You can add upto 10 button on Quick Reply option.

Should be:

- You can add up to 10 buttons in the Quick Reply option.

Changes needed:

• "upto" → "up to" (two words)
• "button" → "buttons" (plural)
• "on" → "in" (better grammar)

⚠️ Still pending from original feedback:

The flow editor screenshots (lines 195, 199, 203, 209) still appear to use the old UI. These are the screenshots in the "How to use HSM Templates in your flows" section showing:

• Send Message action type selection
• HSM Template tab
• Template selection in the flow editor
• Final flow with HSM template

These screenshots should be updated to reflect the current UI.

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (2)

docs/4. Product Features/06. HSM Templates.md (2)

60-60: Hyphenate compound adjective.

This issue was previously flagged. The phrase "drop down" should be hyphenated as "drop-down" to comply with documentation standards.

-    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.

---

103-103: Replace emphasis with proper markdown heading.

This issue was previously flagged. The text "Static URL" uses emphasis instead of a proper heading level, violating markdown linting rules (MD036).

-**Static URL**
+### Static URL

Also apply the same fix to line 118, which has "Dynamic URL":

-**Dynamic URL**
+### Dynamic URL

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 119342e and ce0e674.

📒 Files selected for processing (1)

• docs/4. Product Features/06. HSM Templates.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/06. HSM Templates.md

[grammar] ~60-~60: 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)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/06. HSM Templates.md

88-88: Unordered list indentation
Expected: 0; Actual: 3

(MD007, ul-indent)

---

103-103: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)

docs/4. Product Features/06. HSM Templates.md (1)

316-322: Bulk Apply section correctly expanded for up to 10 Quick Replies.

The addition of Quick Reply fields 4–10 (lines 316–322) properly extends the bulk‑apply documentation to support the new limit of up to 10 Quick Reply buttons, maintaining consistent formatting with fields 1–3.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Correct unordered list indentation.

The nested list items under section "i" use inconsistent indentation that violates markdown standards (MD007). The dashes at lines 88, 93, etc. should align without the 3-space offset, or use a consistent indentation pattern throughout.

     i. `Add Buttons` - You can use `Add Buttons` checkbox to use buttons in HSM templates.
 
-    - Call to Action is selected by default. Click the dropdown and select the Quick Replies option.
+    - Call to Action is selected by default. Click the dropdown and select the Quick Replies option.

Ensure all nested bullet points (lines 88, 93, and others in this block) follow consistent indentation: either left-aligned or properly nested with 2-space indentation.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

88-88: Unordered list indentation
Expected: 0; Actual: 3

(MD007, ul-indent)

🤖 Prompt for AI Agents

In docs/4. Product Features/06.  HSM Templates.md around lines 88 to 94, the
nested unordered list indentation is inconsistent (MD007); fix by aligning the
top-level dashes at the same column and normalizing nested bullets to a
consistent 2-space indentation level (or left-align all bullets) throughout this
block so each nested item is indented exactly two spaces from its parent and all
list markers line up uniformly.