Skip to content

Flow overview.md#360

Open
SangeetaMishr wants to merge 6 commits into
mainfrom
Flow__Overview.md
Open

Flow overview.md#360
SangeetaMishr wants to merge 6 commits into
mainfrom
Flow__Overview.md

Conversation

@SangeetaMishr
Copy link
Copy Markdown
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

  • Documentation
    • Updated Flow Overview documentation metadata.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 30, 2025

Warning

Rate limit exceeded

@SangeetaMishr has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 38 minutes and 20 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5ca2c306-80d7-42e5-b0c1-1afa5cd64194

📥 Commits

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

📒 Files selected for processing (1)
  • docs/4. Product Features/03. Flows/1. Flow Overview.md
📝 Walkthrough

Walkthrough

Documentation metadata in the Flow Overview is refreshed by updating the "Last Updated" timestamp from October 2025 to May 2026. This is a single-line change to the document header that indicates when the documentation was last reviewed or updated.

Documentation metadata update

Layer / File(s) Summary
Update Flow Overview timestamp
docs/4. Product Features/03. Flows/1. Flow Overview.md
The "Last Updated" field in the Flow Overview documentation header is changed from October 2025 to May 2026.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • glific/docs#568: Both PRs update Flow overview/documentation metadata timestamps.
  • glific/docs#312: Both PRs modify the same Flow Overview documentation file with different documentation enhancements.

Suggested reviewers

  • shijithkjayan

Poem

🐰 A timestamp hops through time so fast,
From autumn past to spring at last,
The docs now show May's gleaming date,
A simple change, but oh, so great! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Flow overview.md' is vague and does not clearly convey the actual change made to the pull request, which is updating metadata in the Flow Overview documentation. Use a more descriptive title that explains the change, such as 'Update Flow Overview documentation last updated date to May 2026' or 'Add FAQ section to Flow Overview documentation'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • 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

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

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown

github-actions Bot commented Aug 25, 2025

@github-actions github-actions Bot temporarily deployed to pull request August 25, 2025 07:09 Inactive
@github-actions github-actions Bot temporarily deployed to pull request May 20, 2026 06:28 Inactive
@SangeetaMishr SangeetaMishr requested review from Fawas003 and mahajantejas and removed request for mahajantejas May 20, 2026 06:45
@github-actions github-actions Bot temporarily deployed to pull request May 20, 2026 06:50 Inactive
@SangeetaMishr
Copy link
Copy Markdown
Collaborator Author

@Fawas003 - Can you review this please.

@Fawas003
Copy link
Copy Markdown
Contributor

Fawas003 commented May 21, 2026

@SangeetaMishr I couldn't see any change other than the date, what i need to review specifically

@SangeetaMishr
Copy link
Copy Markdown
Collaborator Author

@Fawas003 It was a old PR which was already approved but due to some conflicts it didn't get merge to main, I took help from Priyanshu. You can go ahead and merge it for now.

@Fawas003
Copy link
Copy Markdown
Contributor

@SangeetaMishr review completed, but unable to merge. It seems like like you will have to update the branch

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.

5 participants