Skip to content

Conversation

@tanuprasad530
Copy link
Contributor

@tanuprasad530 tanuprasad530 commented Oct 30, 2025

Added one section about adding translation to interactive message, once it has been already created and used in the editor.
closes #449

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for translating and localizing interactive messages across communication flows. New documentation covers editing message translations directly in the interface, updating translations through the flow editor, testing functionality across multiple languages, and includes detailed step-by-step instructions with visual screenshots for each workflow stage.

Added one section about adding translation to interactive message, once it has been already created and used in the editor
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2025

Walkthrough

Documentation expansion adds a "Steps to add translations" guide explaining how to update translations for interactive messages in flows, covering editing translations within the message, updating in the flow editor, and testing across languages. The section is duplicated within the same file.

Changes

Cohort / File(s) Summary
Documentation: Translation Setup Guide
docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an interactive message.md
Added new multi-step guide section "Steps to add translations" with instructions for managing translations after interactive message creation, including within-message translation editing, flow editor updates, and multi-language testing; content appears duplicated in two locations within the file

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the translation workflow steps are accurate and align with the current UI
  • Confirm whether the duplication of the guide section is intentional or should be consolidated
  • Validate that screenshots and step descriptions match the actual product interface

Possibly related PRs

Suggested reviewers

  • SangeetaMishr

Poem

🐰 Translations bloom in flowery ways,
Step by step through multilingual maze,
Messages dance in languages bright,
Guides expanded, documentation's delight! ✨📝

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings, 2 inconclusive)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning The changes are primarily in scope, as the PR modifies only the documentation file and adds content directly related to issue #449's objective of documenting translation workflows. However, the summary notes that "the section appears to be inserted in two places, duplicating the same guidance." This duplication may indicate either an unintended mistake during editing or a deliberate inclusion that warrants clarification. The fact that multiple identical sections exist in the same file suggests the changes may not have been fully reviewed for consistency and organization. Investigate and resolve the duplication of the "Steps to add translations" section. Determine whether both instances should be retained (which would be unusual for documentation) or whether this is an editing error that should be corrected. Ensure that the final documentation has a single, well-organized explanation of the translation workflow to maintain clarity and avoid reader confusion.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Title Check ❓ Inconclusive The pull request title "Update 03. Send the contact an interactive message.md" is overly vague and generic. While it correctly identifies the file being modified, it fails to convey the specific nature of the change. The title does not communicate that the update adds documentation about adding translations to interactive messages post-creation, which is the core objective. A more descriptive title would help reviewers quickly understand the purpose of the change. Consider revising the title to be more specific about the actual change, such as "Add documentation for post-creation translation workflow in interactive messages" or "Document how to add translations to interactive messages in Wait for response node". This would make the PR's intent immediately clear to anyone reviewing the commit history.
Linked Issues Check ❓ Inconclusive The PR addresses the primary objective from issue #449 by adding documentation about the translation workflow for interactive messages after creation. According to the summary, a new "Steps to add translations" section was added that covers updating translations within the interactive message and in the flow editor. However, the summary does not provide specific confirmation that all detailed requirements from the issue are fully addressed, particularly regarding the explicit distinction of Rule and Category Translations tabs and the mechanics of switching the editor pane for different languages. The information provided suggests alignment with the issue's intent, but lacks sufficient detail to confirm comprehensive coverage of all stated requirements. Review the actual documentation content to verify that all specific requirements from issue #449 are covered: the translation process in the 'Wait for response' node, explicit explanation of Rule versus Category Translations tabs, and detailed steps for switching the editor pane to different languages. Confirm that the documentation comprehensively addresses each of these aspects mentioned in the issue.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch send_contact_an_interactive_message.md

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

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

@github-actions
Copy link

@github-actions github-actions bot temporarily deployed to pull request October 30, 2025 03:23 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 849cbed and fbf8e53.

📒 Files selected for processing (1)
  • docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an interactive message.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an interactive message.md

[style] ~189-~189: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...2c671-3630-4fea-8489-4af66e4ae7b4" /> In the Category Translation tab, you can...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 markdownlint-cli2 (0.18.1)
docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an interactive message.md

149-149: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


179-179: Link text should be descriptive

(MD059, descriptive-link-text)

🔇 Additional comments (1)
docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an interactive message.md (1)

147-148: Verify duplication of the translation guide section.

The AI-generated summary indicates that the "Steps to add translations" section appears duplicated within this file. The provided code shows only one instance (lines 149–196). Please confirm whether the section is truly duplicated in the actual PR and, if so, consolidate into a single section.


<p><b>Note:</b> It’s best to add translations while creating the interactive message. You can also add them later by switching languages in the flow editor and updating category/rule translations. Adding translations during creation—either via auto-translate or manually—automatically populates the corresponding category and rule translation fields.</p>

### Steps to add translations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading level: should be h2, not h3.

The "Steps to add translations" section uses ### (h3) but other main sections in this document use ## (h2). For consistency, change this to a level-2 heading.

-### Steps to add translations
+## Steps to add translations
📝 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.

Suggested change
### Steps to add translations
## Steps to add translations
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

149-149: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents
In docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an
interactive message.md around line 149, the "Steps to add translations" heading
is currently level-3 (###); change it to level-2 (##) so it matches other main
sections and maintains consistent heading hierarchy across the document.


<img width="596" height="381" alt="Screenshot 2025-10-29 at 8 54 34 PM" src="https://github.com/user-attachments/assets/77a8361e-80ce-4336-b17f-3ff7b589718e" />

Note: The values entered under validations such as `has only the phrase`, `has a number`, etc. act as rules to verify whether a user’s response matches the expected input. These are grouped into categories, as shown below. Depending on the design, these categories may or may not be visible to the end user. Learn more about `Wait for Response` [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Wait%20for%20the%20contact%20to%20respond).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Use descriptive link text instead of "here".

The link text "here" is non-descriptive. Anchor the link directly to the referenced resource name or provide more context.

-Learn more about `Wait for Response` [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Wait%20for%20the%20contact%20to%20respond).
+[Learn more about Wait for Response](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Wait%20for%20the%20contact%20to%20respond).
📝 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.

Suggested change
Note: The values entered under validations such as `has only the phrase`, `has a number`, etc. act as rules to verify whether a users response matches the expected input. These are grouped into categories, as shown below. Depending on the design, these categories may or may not be visible to the end user. Learn more about `Wait for Response` [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Wait%20for%20the%20contact%20to%20respond).
Note: The values entered under validations such as `has only the phrase`, `has a number`, etc. act as rules to verify whether a user's response matches the expected input. These are grouped into categories, as shown below. Depending on the design, these categories may or may not be visible to the end user. [Learn more about Wait for Response](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Wait%20for%20the%20contact%20to%20respond).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

179-179: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents
In docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an
interactive message.md around line 179, the link uses non-descriptive anchor
text "here"; change the anchor text to a descriptive phrase such as "Wait for
Response documentation" or "Wait for the contact to respond" so the link clearly
indicates the destination, keeping the URL unchanged.

Comment on lines +185 to +191
In the `Rule Translations` tab and enter the corresponding translations for the button text. In cases where the validation type is set to `has any of the words`, you can add the translated terms as comma-separated values, and continue similarly for other validation types.

<img width="631" height="412" alt="Screenshot 2025-10-30 at 8 44 40 AM" src="https://github.com/user-attachments/assets/1cd2c671-3630-4fea-8489-4af66e4ae7b4" />


In the `Category Translation` tab, you can add translated category names as per your design requirements. If no translations are provided here, the system will use the default values when referenced, for example, in the above case, if hindi category translations are not added, when the category name is referenced as `@results.topic_selected.category.` In Hindi, the default category names (which are in english) will be picked.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Clarify sentence structure and grammar.

Line 185 has a grammatical issue: "In the Rule Translations tab and enter..." needs restructuring. Additionally, lines 190–191 form a very long, complex sentence combining multiple concepts. Split into shorter, clearer sentences.

-In the `Rule Translations` tab and enter the corresponding translations for the button text. In cases where the validation type is set to `has any of the words`, you can add the translated terms as comma-separated values, and continue similarly for other validation types.
+In the `Rule Translations` tab, enter the corresponding translations for the button text. For validation types like `has any of the words`, add translated terms as comma-separated values; continue similarly for other validation types.

-In the `Category Translation` tab, you can add translated category names as per your design requirements. If no translations are provided here, the system will use the default values when referenced, for example, in the above case, if hindi category translations are not added, when the category name is referenced as `@results.topic_selected.category.` In Hindi, the default category names (which are in english) will be picked.
+In the `Category Translation` tab, add translated category names as per your design requirements. If no translations are provided here, the system uses default values when referenced. For example, if Hindi category translations are not added and the category name is referenced as `@results.topic_selected.category`, the default English category names will be used.
🧰 Tools
🪛 LanguageTool

[style] ~189-~189: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...2c671-3630-4fea-8489-4af66e4ae7b4" /> In the Category Translation tab, you can...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🤖 Prompt for AI Agents
docs/4. Product Features/03. Flows/2. Flow Actions/03. Send the contact an
interactive message.md lines 185-191: the paragraph has grammatical errors and
an overly long sentence—rewrite the first sentence to remove the stray "and"
(e.g., "Open the Rule Translations tab and enter...") and split the long
sentence about Category Translation and defaulting behavior into two or three
clearer sentences; explicitly state that if no category translations are
provided, the system will fall back to default (English) names and give the
example separately (e.g., "If no translations are provided, the system uses the
default English names. For example: when the category is referenced as
@results.topic_selected.category, Hindi will display the default English
category name.").

@SangeetaMishr SangeetaMishr merged commit e38043d into main Oct 30, 2025
7 checks passed
@SangeetaMishr SangeetaMishr deleted the send_contact_an_interactive_message.md branch October 30, 2025 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Existing Doc update - translations to add in 'Wait for response' node

3 participants