Update 08. Add or Remove the contact to a collection.md#387
Conversation
updated the documentation with recent images and added why of it with steps
WalkthroughDocumentation for the Flow Actions "Add or Remove the contact to a collection" was rewritten: metadata updated, content reorganized with step-by-step Add and Remove instructions, examples, verification steps, deduplication and edge-case notes, and updated screenshots. No code or API changes. Changes
Sequence Diagram(s)Not applicable: no changes to control flow or runtime behavior were introduced. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related issues
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (7)
1-9: Replace HTML table header with simple, responsive metadataInline HTML tables with fixed widths hurt responsiveness and add maintenance overhead. Prefer plain Markdown and hyphenate “5-minute read.” Consider relying on the site’s built-in “last updated” metadata if available.
-<h3> - <table> - <tr> - <td><b>5 minute read</b></td> - <td style="padding-left:40px;"><b> Level: Beginner</b></td> - <td style="padding-left:40px;"><b>Last Updated: August 2025</b></td> - </tr> - </table> -</h3> +_5-minute read · Beginner · Updated: August 2025_Please confirm whether the docs site already renders “Last updated” automatically. If yes, drop the manual date to avoid drift.
12-15: Tighten wording and avoid code ticks for non-UI nounsBackticks are best kept for UI labels. Also simplify phrasing.
-**`Collections` will help to group contacts based on their specific criteria or location to enable targeted campaigns, surveys, or follow-ups.** - -**The `Add to Collection` and `Remove from Collection` actions in a flow automatically include or exclude contacts from a collection as they move through the flow. For detailed guidance, refer to the complete [documentation](https://glific.github.io/docs/docs/Product%20Features/Others/Collections/) on `Collections`.** +Collections help you group contacts by criteria (e.g., location) to enable targeted campaigns, surveys, or follow-ups. + +The `Add to Collection` and `Remove from Collection` flow actions automatically include or exclude contacts from a collection as contacts move through a flow. For details, see the [Collections](https://glific.github.io/docs/docs/Product%20Features/Others/Collections/) documentation.
27-35: Clarify steps, standardize action label casing, and fix “OK” capitalizationMinor clarity and grammar improvements. Please confirm the exact action label in the UI.
-1. Open your flow +1. Open your flow. -2. Drag the red dot under the node and search for the node `add contact to the collection` where you want the contact to be added to a collection. +2. Click the red connector on the node and search for the `Add contact to a collection` action where you want to add the contact. 3. Select an existing collection from the dropdown. -You can also create a collection while adding the collection node in the flow if one doesn’t already exist. +Tip: You can create a new collection inline if one doesn’t already exist. -4. Click on Ok and publish your flow. +4. Click OK and publish your flow.
40-43: Use “contact” consistently and normalize casingAlign terminology with the rest of the doc and format the action name consistently.
-### What Happens When the Same User Passes Through This Node Again? +### What happens when the same contact passes through this node again? -If a user passes through the Add to Collection node again in the same or another flow, they will not be added twice to the collection. Each contact can appear only once in a collection. +If a contact passes through the `Add to Collection` action again in the same or another flow, they won’t be added twice to the collection. Each contact can appear only once in a collection.
44-51: Fix heading phrasing and step numbering/wordingUse sentence case for headings, “Manage > Collections” for nav, and consistent “1.” numbering.
-### How to Verify If the Contact Was Added to the Collection +### How to verify whether the contact was added to the collection -1) Go to the left panel in the Glific Platform Manage >> Collections page from the left menu. +1. In Glific, go to Manage > Collections. -2) Search for the collection name you used in the flow. +2. Search for the collection name you used in the flow. -3) Click on the collection and you will see the list of contacts who have been added to it. +3. Open the collection to see the list of contacts added to it.
53-57: Title-case and tighten copy; avoid bolding entire paragraphSmall tone and clarity improvements.
-## Remove the contact from a Collection +## Remove a contact from a collection -**Removing contacts from a collection is useful when they no longer meet the criteria for being in that group. - For example: If someone cancels their registration for an event, you can remove them from the “Registered Participants” collection.** +Removing contacts from a collection is useful when they no longer meet the criteria for that group. +For example, if someone cancels their registration for an event, remove them from the "Registered participants" collection.
62-62: Use Markdown image and repo-hosted asset with descriptive altSame rationale as the earlier image: prefer Markdown syntax and a stable, repo-local path.
-<img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8e9a-6aadbc732692" /> +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md(1 hunks)
🔇 Additional comments (1)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (1)
60-68: Clarify grammar and verify UI labels in flow action docsThe wording has been tightened and spacing fixed. Please confirm the exact product text for the action name and checkbox label so this mirrors the UI precisely.
Affected file:
- docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (lines 60–68)
Proposed diff:
-1. In your flow, click on the red dot under a node and search for the node to “remove the contact from a collection” when you want the contact to be removed from the collection. +1. In your flow, click the red connector on a node and search for the `Remove contact from a collection` action where you want to remove the contact. -2. Select the collection name from the drop down. +2. Select the collection name from the dropdown. -3. You can also check the box remove from all this action will remove the contacts from all the collections where it has been added. +3. Optional: Check “Remove from all” to remove the contact from every collection they belong to. + +Note: This action cannot be undone. Use with caution. -4. Click on ok and publish your flow. +4. Click OK and publish your flow.Questions for verification:
- Is the action labeled exactly Remove contact from a collection?
- Is the checkbox label Remove from all?
- Are “OK” and “dropdown” the correct button and UI terms?
| **Examples:** | ||
|
|
||
| 1. Select `Add to Collection` type from the node. Select the collection in which contact needs to be added. | ||
| - Add to Collection: When a contact provides consent to receive future messages, the contact can be added to an Opt-in collection. | ||
| If a contact shares a location preference, such as Maharashtra, the contact can be added to a Maharashtra collection. | ||
|
|
||
| - Remove from Collection: When a contact completes a feedback survey or an activity for a specific week or month, the contact can be removed from the Feedback collection. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix list structure and typos in “Examples” (missing bullet, double-space, clarity)
The second example line is detached from its bullet and there’s a double space in “Feedback collection.” Nested bullets improve readability.
-**Examples:**
-
-- Add to Collection: When a contact provides consent to receive future messages, the contact can be added to an Opt-in collection.
-If a contact shares a location preference, such as Maharashtra, the contact can be added to a Maharashtra collection.
-
-- Remove from Collection: When a contact completes a feedback survey or an activity for a specific week or month, the contact can be removed from the Feedback collection.
+**Examples**
+
+- Add to Collection:
+ - When a contact provides consent to receive future messages, add them to an "Opt-in" collection.
+ - If a contact shares a location preference (e.g., "Maharashtra"), add them to a "Maharashtra" collection.
+
+- Remove from Collection:
+ - When a contact completes a feedback survey or an activity for a specific week or month, remove them from the "Feedback" collection.📝 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.
| **Examples:** | |
| 1. Select `Add to Collection` type from the node. Select the collection in which contact needs to be added. | |
| - Add to Collection: When a contact provides consent to receive future messages, the contact can be added to an Opt-in collection. | |
| If a contact shares a location preference, such as Maharashtra, the contact can be added to a Maharashtra collection. | |
| - Remove from Collection: When a contact completes a feedback survey or an activity for a specific week or month, the contact can be removed from the Feedback collection. | |
| **Examples** | |
| - Add to Collection: | |
| - When a contact provides consent to receive future messages, add them to an "Opt-in" collection. | |
| - If a contact shares a location preference (e.g., "Maharashtra"), add them to a "Maharashtra" collection. | |
| - Remove from Collection: | |
| - When a contact completes a feedback survey or an activity for a specific week or month, remove them from the "Feedback" collection. |
🤖 Prompt for AI Agents
In docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the
contact to a collection.md around lines 16 to 22, fix the list structure by
ensuring the second example line is properly indented as a nested bullet under
"Add to Collection" and remove the double space in "Feedback collection." Also,
improve clarity by using nested bullets for related examples to enhance
readability.
| 4. Click on Ok and publish your flow. | ||
|
|
||
| <img width="565" height="405" alt="image" src="https://github.com/user-attachments/assets/b4ebd8f1-6080-45cd-8a16-6520460299b3" /> | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Use repo-hosted images with descriptive alt text; avoid fixed dimensions
“user-attachments” links are brittle, and width/height break responsive layouts. Prefer Markdown image syntax with a repo-hosted asset and a meaningful alt.
-<img width="565" height="405" alt="image" src="https://github.com/user-attachments/assets/b4ebd8f1-6080-45cd-8a16-6520460299b3" />
+If the asset isn’t in the repo yet, please add it under the docs’ images/static folder and update the path accordingly.
To find any remaining external “user-attachments” links:
🏁 Script executed:
#!/bin/bash
rg -n "user-attachments/assets" -A 1 docsLength of output: 69951
Replace external images in flow actions with repo-hosted assets
The file docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md still contains two <img> tags pointing at github.com/user-attachments with hard-coded width/height. These links are brittle and break responsive layouts. Please:
• Copy both screenshots into your docs repo under docs/images/flows/actions/
• Remove the <img> tags and use Markdown syntax with descriptive alt text (omit fixed dimensions)
Updated diff for lines 37 and 62 in that file:
-<img width="565" height="405" alt="image" src="https://github.com/user-attachments/assets/b4ebd8f1-6080-45cd-8a16-6520460299b3" />
+
-<img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8e9a-6aadbc732692" />
+To ensure no external attachments remain, run:
rg -n "user-attachments/assets" -A 1 docs🤖 Prompt for AI Agents
In docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the
contact to a collection.md at lines 37 and 62, replace the existing <img> tags
that reference external github.com/user-attachments URLs with Markdown image
syntax using local copies of those images stored in docs/images/flows/actions/.
Remove the fixed width and height attributes and provide descriptive alt text
for each image. This will prevent broken links and improve responsive layout
handling.
|
🚀 Deployed on https://deploy-preview-387--glific-docs.netlify.app |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (2)
16-22: Fix list structure, indentation, and double-space in “Examples”The second example line should be a nested bullet under “Add to Collection”; also fix the double space in “Feedback collection.”
-**Examples:** - -- Add to Collection: When a contact provides consent to receive future messages, the contact can be added to an Opt-in collection. -If a contact shares a location preference, such as Maharashtra, the contact can be added to a Maharashtra collection. - -- Remove from Collection: When a contact completes a feedback survey or an activity for a specific week or month, the contact can be removed from the Feedback collection. +**Examples** + +- Add to Collection: + - When a contact provides consent to receive future messages, add them to an "Opt-in" collection. + - If a contact shares a location preference (e.g., "Maharashtra"), add them to a "Maharashtra" collection. + +- Remove from Collection: + - When a contact completes a feedback survey or an activity for a specific week or month, remove them from the "Feedback" collection.
37-37: Replace externaltags with repo-hosted Markdown images (responsive-safe)
Avoid github.com/user-attachments links and fixed dimensions. Use repo-hosted assets and Markdown image syntax with descriptive alt text.
-<img width="565" height="405" alt="image" src="https://github.com/user-attachments/assets/b4ebd8f1-6080-45cd-8a16-6520460299b3" /> +-<img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8e9a-6aadbc732692" /> +Run to confirm no remaining external attachments:
#!/bin/bash rg -n "user-attachments/assets" -A 1 docsAlso applies to: 62-62
🧹 Nitpick comments (5)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (5)
1-9: Avoid JSX-style inline styles in raw HTML; use Markdown or valid HTMLThe attributes style={{ paddingLeft: 40 }} are JSX/MDX-specific and may not render in plain Markdown. Prefer a Markdown table for portability.
-<h3> - <table> - <tr> - <td><b>5 minute read</b></td> - <td style={{ paddingLeft: 40 }}><b>Level: Beginner</b></td> - <td style={{ paddingLeft: 40 }}><b>Last updated: August 2025</b></td> - </tr> - </table> -</h3> +| 5 minute read | Level: Beginner | Last updated: August 2025 | +| --- | --- | --- |If the docs pipeline requires MDX, convert this file to .mdx or replace the JSX style with valid HTML attributes, for example:
style="padding-left: 40px;"
35-35: Standardize button label capitalization and phrasing (“OK”)Use consistent, concise action phrasing.
-4. Click on Ok and publish your flow. +4. Click OK, then publish your flow.-4. Click on ok and publish your flow. +4. Click OK, then publish your flow.Also applies to: 68-68
46-50: Use consistent numbering style and clarify navigation wordingAlign numbering with the rest of the doc and simplify the first step wording.
-1) Go to the left panel in the Glific Platform Manage >> Collections page from the left menu. - -2) Search for the collection name you used in the flow. - -3) Click on the collection and you will see the list of contacts who have been added to it. +1. In Glific, go to Manage > Collections from the left menu. +2. Search for the collection name you used in the flow. +3. Click the collection to view the list of contacts added to it.
25-25: Make section headers consistent in casing and wordingAlign both headers to the same style.
-## Add Contacts to a Collection +## Add contacts to a collection-## Remove the contact from a Collection +## Remove contacts from a collectionAlso applies to: 53-53
42-42: Consistent formatting for UI labelsWrap UI action names in backticks to match earlier usage.
-If a user passes through the Add to Collection node again in the same or another flow, they will not be added twice to the collection. Each contact can appear only once in a collection. +If a user passes through the `Add to Collection` node again in the same or another flow, they will not be added twice to the collection. Each contact can appear only once in a collection.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the contact to a collection.md (2)
14-14: Verify link and prefer relative path if supportedThe absolute link includes “/docs/docs/” and might change across environments. If the site supports it, use a relative link to Collections; otherwise, confirm the current link works.
Proposed relative link (adjust if your docs structure differs):
29-29: Confirm exact node label as shown in the UIEnsure the inline code matches the Flow action’s label to reduce confusion.
Current text:
add contact to the collectionIf the UI label is different (e.g., “Add contact to a collection”), please update it for accuracy.
| 1. In your flow, click on the red dot under a node and search for the node to “remove the contact from a collection” when you want the contact to be removed from the collection. | ||
|
|
||
| 4. Once you click on `View Details` from the collection tile you will be able to find how many contacts are present in the collection. | ||
| <img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8e9a-6aadbc732692" /> | ||
|
|
||
| <img width="1023" alt="image" src="https://github.com/glific/docs/assets/143380171/90dcb765-ab85-4acd-958c-9f99e252a7e9"/> | ||
| 2. Select the collection name from the drop down. | ||
|
|
||
| --- | ||
| ## Remove the contact from a Collection | ||
| 3. You can also check the box remove from all this action will remove the contacts from all the collections where it has been added. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Tighten grammar, fix double-space, and use consistent terminology (“dropdown”, “Remove from all collections”)
This block has a double-space, awkward phrasing, and unclear checkbox label.
-1. In your flow, click on the red dot under a node and search for the node to “remove the contact from a collection” when you want the contact to be removed from the collection.
+1. In your flow, click the red dot under a node and add the “Remove contact from a collection” action where the removal should happen.
@@
-2. Select the collection name from the drop down.
+2. Select the collection name from the dropdown.
@@
-3. You can also check the box remove from all this action will remove the contacts from all the collections where it has been added.
+3. To remove the contact from every collection they belong to, check “Remove from all collections.”📝 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.
| 1. In your flow, click on the red dot under a node and search for the node to “remove the contact from a collection” when you want the contact to be removed from the collection. | |
| 4. Once you click on `View Details` from the collection tile you will be able to find how many contacts are present in the collection. | |
| <img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8e9a-6aadbc732692" /> | |
| <img width="1023" alt="image" src="https://github.com/glific/docs/assets/143380171/90dcb765-ab85-4acd-958c-9f99e252a7e9"/> | |
| 2. Select the collection name from the drop down. | |
| --- | |
| ## Remove the contact from a Collection | |
| 3. You can also check the box remove from all this action will remove the contacts from all the collections where it has been added. | |
| 1. In your flow, click the red dot under a node and add the “Remove contact from a collection” action where the removal should happen. | |
| <img width="562" height="336" alt="image" src="https://github.com/user-attachments/assets/08d5091b-af7e-43cc-8a16-6520460299b3" /> | |
| 2. Select the collection name from the dropdown. | |
| 3. To remove the contact from every collection they belong to, check “Remove from all collections.” |
🤖 Prompt for AI Agents
In docs/3. Product Features/03. Flows/2. Flow Actions/08. Add or Remove the
contact to a collection.md around lines 60 to 66, tighten grammar and spacing,
replace the phrase "remove the contact from a collection" with "remove the
contact from a collection" (remove double-space), change "drop down" to the
single word "dropdown", and reword the checkbox description to a consistent
label such as "Remove from all collections" and a clearer sentence like "You can
also check the box labeled 'Remove from all collections' to remove the contact
from every collection it belongs to."
updated the documentation with recent images and added why of it with steps
Summary by CodeRabbit