Skip to content

Conversation

@SangeetaMishr
Copy link
Collaborator

@SangeetaMishr SangeetaMishr commented Jul 30, 2025

Added the below section into Flow Overview

https://glific.github.io/docs/docs/FAQ/Make%20sure%20flow%20is%20not%20interrupted%20if%20contact%20sends%20any%20keyword%20in%20between%20the%20flow./

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Clarified the description of the "Run this flow in the background + Background Flows" feature.
    • Added a new "Skip Validation" feature description, explaining its use for flows with dynamically generated results.
    • Introduced a section on the "Ignore Keyword" checkbox, including an explanatory screenshot.
    • Added a new section detailing how to make a flow inactive, with step-by-step instructions and screenshots.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 30, 2025

Warning

Rate limit exceeded

@akanshaaa19 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 33 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a47b262 and b7dbb4f.

📒 Files selected for processing (1)
  • docs/3. Product Features/03. Flows/1. Flow Overview.md (3 hunks)

Walkthrough

The documentation for the Flow Listing Page was updated to clarify the "Run this flow in the background + Background Flows" feature, add a new "Skip Validation" feature description, and introduce a section explaining the "Ignore Keyword" checkbox, including a screenshot. A new section on how to make a flow inactive was also added with UI steps. No code or API changes were made.

Changes

Cohort / File(s) Change Summary
Flow Overview Documentation
docs/3. Product Features/03. Flows/1. Flow Overview.md
Refined description of background flow feature, added "Skip Validation" feature explanation, documented "Ignore Keyword" option with screenshot, and added "Make a flow inactive" section with UI steps and screenshots.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • shijithkjayan

Poem

In the warren of docs, a bunny did hop,
Clarifying flows, not missing a stop.
Skip validation? Ignore that word!
With screenshots and prose, the changes are heard.
A carrot for clarity, a thump for delight—
The Flow Overview shines, all features in sight! 🥕✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Flow__Overview.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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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: 0

🧹 Nitpick comments (4)
docs/3. Product Features/03. Flows/1. Flow Overview.md (4)

33-35: Prefer “and” over “+” for readability & searchability

Using the literal “+” inside list titles can hamper readability and keyword-based searching in docs engines.
Consider:

-    - **Run this flow in the background + Background Flows** :
+    - **Run this flow in the background and Background Flows** :

36-36: Fix list-item indentation (MD005)

markdownlint flagged this line because it’s indented by 3 spaces instead of 4, breaking the nested list structure.

-   - **Skip Validation** : Check this box while sending results …
+    - **Skip Validation** : Check this box while sending results …

91-91: Remove trailing punctuation from heading (MD026)

Headings should not end with a period.

-## Make sure flow is not interrupted if contact sends any keyword in between the flow.
+## Make sure flow is not interrupted if contact sends any keyword in between the flow

93-93: Tighten wording for clarity

Minor grammar tweak for smoother reading.

-Select the `Ignore Keyword` check box from edit flow screen to make sure the flow should not be interrupted in between if user sends keyword of another flow.
+Select the `Ignore Keyword` checkbox on the Edit-Flow screen to ensure the active flow is not interrupted when a user sends a keyword that belongs to another flow.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b57070 and b4e4eb6.

📒 Files selected for processing (1)
  • docs/3. Product Features/03. Flows/1. Flow Overview.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/03. Flows/1. Flow Overview.md

36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3

(MD005, list-indent)


91-91: Trailing punctuation in heading
Punctuation: '.'

(MD026, no-trailing-punctuation)

added one more section as Make a flow 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: 0

🧹 Nitpick comments (2)
docs/3. Product Features/03. Flows/1. Flow Overview.md (2)

36-36: Fix list-item indentation to silence markdownlint MD005

markdownlint flags this line because it’s indented 3 spaces while the sibling list items under Edit use 4. Align it for consistent formatting.

-   - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. It lets the flow continue without checking if those result fields were expected.
+    - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. It lets the flow continue without checking if those result fields were expected.

91-91: Remove trailing period from the heading (markdownlint MD026)

Headings should not end with punctuation. Dropping the period keeps style consistent.

-## Make sure flow is not interrupted if contact sends any keyword in between the flow.
+## Make sure flow is not interrupted if contact sends any keyword in between the flow
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4e4eb6 and a47b262.

📒 Files selected for processing (1)
  • docs/3. Product Features/03. Flows/1. Flow Overview.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/03. Flows/1. Flow Overview.md

36-36: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3

(MD005, list-indent)


91-91: Trailing punctuation in heading
Punctuation: '.'

(MD026, no-trailing-punctuation)

Copy link
Collaborator

@mahajantejas mahajantejas left a comment

Choose a reason for hiding this comment

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

There seems to be conflict between branches, so i am not able to merge this.
Can you pls re-look at this one and try again?

@github-actions
Copy link

@github-actions github-actions bot temporarily deployed to pull request August 25, 2025 07:09 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.

4 participants