Skip to content

Flow overview.md#360

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

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

Conversation

@SangeetaMishr

@SangeetaMishr SangeetaMishr commented Jul 30, 2025

Copy link
Copy Markdown
Collaborator

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 the Flow Overview documentation “Last Updated” value to reflect May 2026.

@coderabbitai

coderabbitai Bot commented Jul 30, 2025

Copy link
Copy Markdown
Contributor

Review Change Stack

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ca87bb58-39e1-4cdf-b641-e3981e5ccfd6

📥 Commits

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

📒 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 the current documentation status.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

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 | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states a section was added from a FAQ page, but the actual changeset only shows a date update from October 2025 to May 2026 with no other content changes. Update the description to accurately reflect what was changed: only the 'Last Updated' date was modified from October 2025 to May 2026, with no new sections added.
Title check ❓ Inconclusive The title 'Flow overview.md' is vague and only mentions a filename rather than describing the actual change made to the file. Use a descriptive title that clearly explains the change, such as 'Update Flow Overview documentation with flow interruption section' or 'Add FAQ section to Flow Overview'.
✅ Passed checks (3 passed)
Check name Status Explanation
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.


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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)

@mahajantejas mahajantejas left a comment

Copy link
Copy Markdown
Collaborator

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

github-actions Bot commented Aug 25, 2025

Copy link
Copy Markdown

@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

Fawas003 commented May 21, 2026

Copy link
Copy Markdown
Contributor

@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

@github-actions github-actions Bot temporarily deployed to pull request June 19, 2026 04:03 Inactive

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md:
- Line 105: In the Flow Overview documentation at line 105, the phrase "keyword
encoded links" uses incorrect compound adjective grammar. When a compound
adjective precedes a noun, the words should be connected with hyphens. Change
"keyword encoded links" to "keyword-encoded links" to properly apply the
hyphenation rule for compound adjectives modifying the noun "links".
- Around line 46-48: The list item "Skip Validation" on line 46 has inconsistent
indentation with only 3 spaces before the dash, while other list items at the
same level use 4 spaces. Update the indentation of the entire "Skip Validation"
line and its continuation to use 4 spaces instead of 3 spaces to match the
markdown list formatting standard (MD005) and maintain consistency with
surrounding items.
- Line 44: Replace the generic link text "here" on line 44 with descriptive text
that clearly indicates what the link points to. Since the URL references
Background Flows documentation, change the link text from "here" to something
descriptive like "Background Flows documentation" or "learn more about
Background Flows" so readers understand the destination before clicking.
- Around line 1-12: The markdown file violates MD022 (blanks-around-headings) by
missing blank lines before heading elements. Add a blank line before the primary
heading "# Flow Overview" at the beginning of the file if there is content above
it, and add a blank line between the closing HTML tag "</h3>" and the secondary
heading "## Flow Listing Page" to ensure proper spacing around all heading
elements as per markdown linting standards.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ca87bb58-39e1-4cdf-b641-e3981e5ccfd6

📥 Commits

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md:
- Line 105: In the Flow Overview documentation at line 105, the phrase "keyword
encoded links" uses incorrect compound adjective grammar. When a compound
adjective precedes a noun, the words should be connected with hyphens. Change
"keyword encoded links" to "keyword-encoded links" to properly apply the
hyphenation rule for compound adjectives modifying the noun "links".
- Around line 46-48: The list item "Skip Validation" on line 46 has inconsistent
indentation with only 3 spaces before the dash, while other list items at the
same level use 4 spaces. Update the indentation of the entire "Skip Validation"
line and its continuation to use 4 spaces instead of 3 spaces to match the
markdown list formatting standard (MD005) and maintain consistency with
surrounding items.
- Line 44: Replace the generic link text "here" on line 44 with descriptive text
that clearly indicates what the link points to. Since the URL references
Background Flows documentation, change the link text from "here" to something
descriptive like "Background Flows documentation" or "learn more about
Background Flows" so readers understand the destination before clicking.
- Around line 1-12: The markdown file violates MD022 (blanks-around-headings) by
missing blank lines before heading elements. Add a blank line before the primary
heading "# Flow Overview" at the beginning of the file if there is content above
it, and add a blank line between the closing HTML tag "</h3>" and the secondary
heading "## Flow Listing Page" to ensure proper spacing around all heading
elements as per markdown linting standards.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ca87bb58-39e1-4cdf-b641-e3981e5ccfd6

📥 Commits

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

📒 Files selected for processing (1)
  • docs/4. Product Features/03. Flows/1. Flow Overview.md
🛑 Comments failed to post (4)
docs/4. Product Features/03. Flows/1. Flow Overview.md (4)

1-12: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Address markdown formatting issues with heading spacing.

Lines 1 and 12 are missing blank lines before heading elements, which violates MD022 (blanks-around-headings). Add a blank line before each of these headings.

Fix heading spacing
-# Flow Overview
+
+# Flow Overview

And before line 12:

 </h3>

+
 ## Flow Listing Page
📝 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.


# Flow Overview
<h3>
 <table>
  <tr>
    <td><b>5 minutes read</b></td>
    <td style={{ paddingLeft: '40px' }}><b>Level: Beginner</b></td>
    <td style={{ paddingLeft: '40px' }}><b>Last Updated: May 2026</b></td>
  </tr>
</table>
</h3>

## Flow Listing Page
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 12-12: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md around lines 1 - 12,
The markdown file violates MD022 (blanks-around-headings) by missing blank lines
before heading elements. Add a blank line before the primary heading "# Flow
Overview" at the beginning of the file if there is content above it, and add a
blank line between the closing HTML tag "</h3>" and the secondary heading "##
Flow Listing Page" to ensure proper spacing around all heading elements as per
markdown linting standards.

Source: Linters/SAST tools


44-44: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Use descriptive link text instead of "here".

Line 44 contains a generic link text "here" which provides no context to readers. Replace with descriptive text that explains what the link points to.

Make link text descriptive
-Read more [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Background%20Flows/)
+Read more about [Background Flows](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Background%20Flows/)
📝 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.

Read more about [Background Flows](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Background%20Flows/)
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 44-44: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md at line 44, Replace
the generic link text "here" on line 44 with descriptive text that clearly
indicates what the link points to. Since the URL references Background Flows
documentation, change the link text from "here" to something descriptive like
"Background Flows documentation" or "learn more about Background Flows" so
readers understand the destination before clicking.

Source: Linters/SAST tools


46-48: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Fix inconsistent list indentation.

Line 46 uses 3 spaces of indentation while the surrounding list items at the same level use 4 spaces (MD005). Standardize to 4 spaces for consistency.

Correct indentation
-   - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow).
+    - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow).
📝 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.

    - **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.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 46-46: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 3

(MD005, list-indent)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md around lines 46 - 48,
The list item "Skip Validation" on line 46 has inconsistent indentation with
only 3 spaces before the dash, while other list items at the same level use 4
spaces. Update the indentation of the entire "Skip Validation" line and its
continuation to use 4 spaces instead of 3 spaces to match the markdown list
formatting standard (MD005) and maintain consistency with surrounding items.

Source: Linters/SAST tools


105-105: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Use hyphenated compound adjective.

Line 105 should use a hyphen to join "keyword" and "encoded" as a compound adjective. Change "keyword encoded links" to "keyword-encoded links".

Add hyphen to compound adjective
-You can generate these WhatsApp keyword encoded links by clicking on the "share" icon.
+You can generate these WhatsApp keyword-encoded links by clicking on the "share" icon.
📝 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.

You can generate these WhatsApp keyword-encoded links by clicking on the "share" icon.
🧰 Tools
🪛 LanguageTool

[grammar] ~105-~105: Use a hyphen to join words.
Context: ... You can generate these WhatsApp keyword encoded links by clicking on the "share"...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/03. Flows/1. Flow Overview.md at line 105, In the
Flow Overview documentation at line 105, the phrase "keyword encoded links" uses
incorrect compound adjective grammar. When a compound adjective precedes a noun,
the words should be connected with hyphens. Change "keyword encoded links" to
"keyword-encoded links" to properly apply the hyphenation rule for compound
adjectives modifying the noun "links".

Source: Linters/SAST tools

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