Enhance documentation for Opt-in & Opt-out flows

[SangeetaMishr]

Updated the document to include a table with reading time, level, and last updated information. Added clarification on opt-in and opt-out processes for users.

Summary by CodeRabbit

Release Notes

• Documentation
  • Enhanced opt-in & opt-out preferences documentation with read time estimates, difficulty levels, and last updated timestamps.
  • Added explanation of user behavior and workflow when re-engaging after opting out.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for opt-in & opt-out flows was enhanced with an HTML-styled header containing metadata (read time, difficulty level, last updated), and a new explanatory section describing opt-in behavior when users re-engage after opt-out.

Changes

Cohort / File(s)	Summary
Documentation Enhancement docs/4. Product Features/03. Flows/4. Others/11. Configure Optin & Optout preferences in Glific.md	Replaced markdown header with HTML-styled header containing read time estimate, difficulty level, and last updated timestamp. Added new explanatory section covering keyword-based opt-in flows and re-onboarding behavior post-opt-out.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

Screening

Suggested reviewers

• shijithkjayan
• mahajantejas

Poem

🐰 With whiskers twitched and ears held high,
We've polished docs that catch the eye!
Headers styled in HTML grace,
Opt-in flows in their proper place! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'Enhance documentation for Opt-in & Opt-out flows' accurately summarizes the main objective of the changeset, which focuses on improving documentation clarity with added metadata and detailed explanations.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch optin-and-optout-flow.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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

🚀 Deployed on https://deploy-preview-568--glific-docs.netlify.app

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@docs/4`. Product Features/03. Flows/4. Others/11. Configure Optin & Optout
preferences in Glific.md:
- Around line 74-80: Fix grammar and normalize opt-in/out phrasing under the "##
What happens if a user has opted out and then opts in?" section: reword
sentences to be concise and grammatical, hyphenate consistently as "opt-in" and
"opt-out", change "need opts back in" to "needs to opt back in", and clarify the
two points so they read like "If a contact has previously opted out and then
needs to opt back in: 1) the contact must send the specific keyword (for
example: optin, start, hi) associated with the opt-in flow that updates the
contact; 2) sending that keyword will start the associated opt-in flow even if
the contact was previously marked invalid."
- Around line 1-9: The header uses JSX-style markup (the <h3> and <table>
elements with style={{ ... }}) which won't render in GitHub Markdown; replace
this block by a Markdown-friendly header and table or plain text — remove the
JSX inline styles (style={{ paddingLeft: '40px' }}) and instead use a Markdown
H3 (###) and a Markdown table or simple bullet/inline text to display "5 minutes
read", "Level: Intermediate", and "Last Updated: January 2026" so the content
renders correctly in Markdown.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Use Markdown-friendly header markup (current JSX-style style={{...}} won’t render).

GitHub Markdown doesn’t support JSX-style style={{ ... }}; it will likely render incorrectly or be stripped. Consider a Markdown table or plain text instead.

Suggested Markdown replacement

-<h3>
- <table>
-  <tr>
-    <td><b> 5 minutes read</b></td>
-    <td style={{ paddingLeft: '40px' }}><b>Level: Intermediate </b></td>
-    <td style={{ paddingLeft: '40px' }}><b>Last Updated: January 2026</b></td>
-  </tr>
-</table>
-</h3>
+**5-minute read** | **Level: Intermediate** | **Last Updated: January 2026**
+---|---|---

🤖 Prompt for AI Agents

In `@docs/4`. Product Features/03. Flows/4. Others/11. Configure Optin & Optout
preferences in Glific.md around lines 1 - 9, The header uses JSX-style markup
(the <h3> and <table> elements with style={{ ... }}) which won't render in
GitHub Markdown; replace this block by a Markdown-friendly header and table or
plain text — remove the JSX inline styles (style={{ paddingLeft: '40px' }}) and
instead use a Markdown H3 (###) and a Markdown table or simple bullet/inline
text to display "5 minutes read", "Level: Intermediate", and "Last Updated:
January 2026" so the content renders correctly in Markdown.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Tighten grammar and opt-in wording for clarity.

There are several grammatical errors and inconsistent “optin/opt-in” phrasing that reduce readability. Suggest tightening the sentences and hyphenating “opt-in/opt-out”.

Proposed edit

-If a contact has previously opted out and then need opts back in
+If a contact has previously opted out and then needs to opt back in:
 
-- The user needs to send the specific keyword like optin,start,hi which is associated to the flow which captures optin and saves it in update contact node.
+- The user needs to send a specific keyword (e.g., **optin**, **start**, **hi**) that is associated with the flow which captures opt-in and saves it in the “Update Contact” node.
 
-- By sending the associated keyword that particular opt-in flow will get started, even though the contact was previously marked as invalid.
+- Sending the associated keyword starts that opt-in flow, even if the contact was previously opted out.

🧰 Tools

🪛 LanguageTool

[grammar] ~78-~78: Ensure spelling is correct
Context: ...s associated to the flow which captures optin and saves it in update contact node. -...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents

In `@docs/4`. Product Features/03. Flows/4. Others/11. Configure Optin & Optout
preferences in Glific.md around lines 74 - 80, Fix grammar and normalize
opt-in/out phrasing under the "## What happens if a user has opted out and then
opts in?" section: reword sentences to be concise and grammatical, hyphenate
consistently as "opt-in" and "opt-out", change "need opts back in" to "needs to
opt back in", and clarify the two points so they read like "If a contact has
previously opted out and then needs to opt back in: 1) the contact must send the
specific keyword (for example: optin, start, hi) associated with the opt-in flow
that updates the contact; 2) sending that keyword will start the associated
opt-in flow even if the contact was previously marked invalid."