-
Notifications
You must be signed in to change notification settings - Fork 9
Update 03. Send the contact an interactive message.md #491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Added one section about adding translation to interactive message, once it has been already created and used in the editor
WalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings, 2 inconclusive)
✅ Passed checks (1 passed)
✨ 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-491--glific-docs.netlify.app |
There was a problem hiding this 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
📒 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| ### 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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). | |
| 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.
| 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. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.").
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