Skip to content

docs: rewrite Label the incoming message with best practices#644

Open
SangeetaMishr wants to merge 3 commits into
mainfrom
docs/label-incoming-message-best-practices
Open

docs: rewrite Label the incoming message with best practices#644
SangeetaMishr wants to merge 3 commits into
mainfrom
docs/label-incoming-message-best-practices

Conversation

@SangeetaMishr

@SangeetaMishr SangeetaMishr commented Jul 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes #614

The Label the incoming message page was almost entirely a video embed, and per the issue, ~80% of that video isn't about this node - the part where it's actually used doesn't demonstrate correct usage either.

This replaces it with:

  • How it works: explains that the node labels the contact's last incoming message, not any bot-sent message.
  • Adding the node to your flow: concrete configuration steps against the existing "Add Labels" screenshot.
  • Best practices: the specific guidance requested in the issue - place this node right after a Wait for Response node so the label lands on the reply you actually want, what happens if there's no incoming message yet (no-op), that multiple labels combine rather than overwrite, and to keep label names consistent for reporting.
  • Keeps the video, but demoted to a "Related video" section at the bottom with a caveat that it's a broader flow-building walkthrough rather than being about this node specifically.

Verification

Confirmed the node's actual behavior against glific/glific:

  • lib/glific/flows/action.ex - add_input_labels execution labels context.last_message
  • lib/glific/processor/consumer_flow.ex - last_message is set to the contact's message specifically in continue_current_context, which runs when a flow resumes after the contact replies (i.e., right after a Wait for Response node completes)
  • add_flow_label/2 no-ops when last_message is nil, confirming the node does nothing if there's no incoming message to attach a label to
  • Existing labels and new labels are comma-joined rather than replaced

Test plan

  • Docs site renders the new sections and image correctly
  • Reviewer confirms this matches the intended usage pattern for this node

Summary by CodeRabbit

  • Documentation
    • Updated the “Label the incoming message” page with a clearer structure and a longer estimated read time.
    • Reorganized the content into sections for how it works, how to add the step, and best practices.
    • Moved the video to a dedicated related-video section near the end and added a clearer visual separation.

…ractices

The page was previously almost entirely a video embed that mostly
covers other topics. Add an explanation of how the node actually
works (it labels the contact's last incoming message), configuration
steps, and the best practice of placing it right after a Wait for
Response node so the label lands on the reply you actually want.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@SangeetaMishr, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 33 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 53b24f58-8225-4795-8412-fd27f2d9c6cc

📥 Commits

Reviewing files that changed from the base of the PR and between bde3bda and ae40576.

📒 Files selected for processing (1)
  • docs/4. Product Features/03. Flows/2. Flow Actions/07. Label the incoming message.md
📝 Walkthrough

Walkthrough

This change updates the "Label the incoming message" documentation page. The estimated read time was changed from 1 minute to 2 minutes. The page content was reorganized into new sections: "How it works," "Adding the node to your flow" with numbered steps and a screenshot, and expanded "Best practices" guidance. The previously embedded "Video Tutorial" section was removed and its YouTube iframe relocated to a new "Related video" section near the end of the page, separated by a divider.

Changes

Area Change
Documentation page Updated read-time metadata, restructured content into new sections, relocated video embed

Sequence Diagram(s)

No sequence diagram generated as this change is a documentation-only restructuring with no code or interaction flow to depict.

Estimated code review effort: Medium

Related issues: None mentioned

Related PRs: None mentioned

Suggested labels: documentation

Suggested reviewers: None mentioned

Poem:
A rabbit hops through docs anew,
Moves the video, reorders the view,
"How it works" now leads the way,
Best practices help save the day,
Two minutes read—still hop-worthy too! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the doc rewrite for the Label the incoming message page and mentions the added best practices.
Description check ✅ Passed The description is directly about the documentation rewrite and the node's usage guidance, matching the changeset.
Linked Issues check ✅ Passed The PR addresses #614 by replacing the video-focused page with written docs and adding the requested best-practice guidance after Wait for Response.
Out of Scope Changes check ✅ Passed The changes stay within the documentation rewrite scope and do not introduce unrelated code or content changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

@github-actions github-actions Bot temporarily deployed to pull request July 4, 2026 12:33 Inactive
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to pull request July 4, 2026 13:00 Inactive
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.

Label an incoming message node - Update documentation

2 participants