Skip to content

Conversation

@SangeetaMishr
Copy link
Collaborator

@SangeetaMishr SangeetaMishr commented Dec 24, 2025

reworded sections as per current need

Summary by CodeRabbit

  • Documentation
    • Simplified WhatsApp Groups Automation setup to a clearer two-step connection flow; removed redundant intermediate steps.
    • Expanded pre-requisites: WhatsApp groups must exist and the phone number must be a member; added naming/visibility guidance.
    • Reordered setup steps and updated wording for clarity.
    • Added visual aids (new images) and metadata (read time, difficulty, last updated).

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 24, 2025

📝 Walkthrough

Walkthrough

Updated a single documentation page: replaced the inline Beginner badge with an HTML metadata table, expanded and reordered prerequisites, and simplified the Maytapi→Glific connection flow into a two-step sequence with adjusted wording and images.

Changes

Cohort / File(s) Summary
Documentation page
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md
Replaced inline badge with an HTML metadata table (5 minutes read, Level: Beginner, Last Updated: December 2025). Expanded prerequisites to require created WhatsApp groups and phone membership, clarified naming/visibility checks. Restructured setup: instruct to create a Maytapi account, copy product id/token, paste into Glific settings and save; condensed former multi-step Glific inputs into a two-step flow, adjusted images and narrative accordingly.

Sequence Diagram(s)

(omitted — documentation-only flow change, no multi-component control-flow modification)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • tanuprasad530

Poem

🐇 I hopped through lines and trimmed the trails,
Badges swapped for tables, shorter sails,
Prereqs tidy, steps now few,
A lighter path for setting up you —
Hooray! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly identifies the specific document being updated and matches the main change summarized in the PR objectives and raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Setting-up-WhatsApp-Groups-Automation-for-existing-NGOs.md

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6fe5e11 and 9414a93.

📒 Files selected for processing (1)
  • docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md
🧰 Additional context used
🪛 LanguageTool
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md

[uncategorized] ~25-~25: The name of this company should be capitalized.
Context: ...nsole.maytapi.com/login) 2. Log in with google id and link a phone number (follow inst...

(GOOGLE_PRODUCTS)


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.

@github-actions
Copy link

github-actions bot commented Dec 24, 2025

@github-actions github-actions bot temporarily deployed to pull request December 24, 2025 04:53 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: 1

🧹 Nitpick comments (2)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md (2)

24-24: Wrap bare URL in markdown link syntax.

For consistency with markdown conventions, wrap the URL in link syntax.

🔎 Proposed fix
-1. Create Maytapi account at https://console.maytapi.com/login
+1. Create Maytapi account at [https://console.maytapi.com/login](https://console.maytapi.com/login)

25-25: Capitalize product name "Google".

"google id" should be capitalized as a proper noun.

🔎 Proposed fix
-2. Log in with google id and link a phone number (follow instructions given on Maytapi page)
+2. Log in with Google ID and link a phone number (follow instructions given on Maytapi page)
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8124145 and c9fad52.

📒 Files selected for processing (1)
  • docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md
🧰 Additional context used
🪛 LanguageTool
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md

[uncategorized] ~25-~25: The name of this company should be capitalized.
Context: ...nsole.maytapi.com/login 2. Log in with google id and link a phone number (follow inst...

(GOOGLE_PRODUCTS)


[grammar] ~28-~28: Ensure spelling is correct
Context: ...in to Glific account, go to settings >> Maytpayi and paste the product id and token id and c...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md

24-24: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md (2)

1-9: Verify HTML/JSX syntax compatibility with documentation platform.

The inline style attribute uses JSX syntax ({{ paddingLeft: '40px' }}) rather than standard HTML (style="padding-left: 40px"). Confirm this is the correct syntax for your documentation rendering system to prevent rendering issues.


32-41: Clarify webhook configuration requirement in simplified workflow.

The workflow consolidation removes detail about entering the Maytapi webhook URL in Glific settings (lines 34–38). It's unclear whether:

  1. Users still need to configure the webhook, but it's implied or documented elsewhere
  2. The webhook configuration was intentionally removed

Line 34's webhook URL (https://api.**ngo-shortcode**.glific.com/maytapi) is essential for the Maytapi integration to function. Ensure the final instructions clearly indicate all required steps. If the webhook setup is still needed, restore clear guidance with the specific settings path in Glific or confirm this is now auto-configured.

3. Set up the payment option (~30$ per phone per month) in Maytapi.
4. Or proceed with free trial which disables the connection in 3 days.
5. Make a note of the "product id" and "token" given by Maytapi. This needs to be shared with the Glific team.
5. Copy of the "product id" and "token" given by Maytapi and then login to Glific account, go to settings >> Maytpayi and paste the product id and token id and click on save.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix spelling error and improve instruction phrasing.

Line 28 contains a spelling error ("Maytpayi" should be "Maytapi") and awkward phrasing that should be clarified for users following the setup.

🔎 Proposed fix
-5. Copy of the "product id" and "token" given by Maytapi and then login to Glific account, go to settings >> Maytpayi and paste the product id and token id and click on save.
+5. Copy the "product id" and "token" from Maytapi, then log in to your Glific account, go to Settings >> Maytapi, paste the product id and token, and click Save.
📝 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.

Suggested change
5. Copy of the "product id" and "token" given by Maytapi and then login to Glific account, go to settings >> Maytpayi and paste the product id and token id and click on save.
5. Copy the "product id" and "token" from Maytapi, then log in to your Glific account, go to Settings >> Maytapi, paste the product id and token, and click Save.
🧰 Tools
🪛 LanguageTool

[grammar] ~28-~28: Ensure spelling is correct
Context: ...in to Glific account, go to settings >> Maytpayi and paste the product id and token id and c...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for
existing NGOs.md around line 28, fix the spelling "Maytpayi" to "Maytapi" and
rewrite the sentence for clarity: instruct the user to copy the "product id" and
"token" from Maytapi, log in to their Glific account, navigate to Settings →
Maytapi, paste the product id and token into the corresponding fields, and click
Save.

Copy link
Contributor

@tanuprasad530 tanuprasad530 left a comment

Choose a reason for hiding this comment

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

The screenshot in step 2 - of the Glific UI where the copied details are added, please include that in step 2, point 2

added the image in Step 1 as it made more relevant there.
@github-actions github-actions bot temporarily deployed to pull request December 26, 2025 02:44 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: 3

♻️ Duplicate comments (1)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md (1)

28-28: Fix spelling error and improve instruction clarity.

This comment addresses issues flagged in the previous review cycle. The line contains the spelling error "Maytpayi" (should be "Maytapi"), redundant terminology ("token id" should be "token"), and awkward phrasing.

🔎 Proposed fix
-5. Copy of the `product id` and `token` given by `Maytapi` and then login to `Glific` account >> Go to `Settings` >> `Maytpayi` and paste the `product id` and `token id` and click on `save`.
+5. Copy the `product id` and `token` from `Maytapi`, then log in to your `Glific` account, go to `Settings` > `Maytapi`, paste the `product id` and `token`, and click `Save`.
🧹 Nitpick comments (1)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md (1)

43-44: Standardize capitalization of button labels.

For consistency with inline code formatting conventions, capitalize button names. Line 28 uses backtick-wrapped save, but line 43 uses lowercase "save" without backticks.

🔎 Proposed fix
-2. Click on save
+2. Click `Save`
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9fad52 and 6fe5e11.

📒 Files selected for processing (1)
  • docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md
🧰 Additional context used
🪛 LanguageTool
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md

[uncategorized] ~25-~25: The name of this company should be capitalized.
Context: ...nsole.maytapi.com/login 2. Log in with google id and link a phone number (follow inst...

(GOOGLE_PRODUCTS)

🪛 markdownlint-cli2 (0.18.1)
docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for existing NGOs.md

24-24: Bare URL used

(MD034, no-bare-urls)

#### Step 1: Connecting Phone number to Maytapi

1. Create Maytapi account at https://console.maytapi.com/login
2. Log in with google id and link a phone number (follow instructions given on Maytapi page)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Capitalize company name in "Google ID".

Per style conventions, company names and proper nouns should be capitalized.

🔎 Proposed fix
-2. Log in with google id and link a phone number (follow instructions given on Maytapi page)
+2. Log in with Google ID and link a phone number (follow instructions given on Maytapi page)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~25-~25: The name of this company should be capitalized.
Context: ...nsole.maytapi.com/login 2. Log in with google id and link a phone number (follow inst...

(GOOGLE_PRODUCTS)

🤖 Prompt for AI Agents
In docs/6. WhatsApp Groups Automation/Setting up WhatsApp Groups Automation for
existing NGOs.md around line 25, the term "google id" should use proper
capitalization for the company name; change it to "Google ID" so the proper noun
"Google" is capitalized and preserve "ID" uppercase for the identifier.

mahajantejas and others added 3 commits December 26, 2025 12:35
…Automation for existing NGOs.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…Automation for existing NGOs.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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