-
Notifications
You must be signed in to change notification settings - Fork 9
Update Onboarding for new NGOs.md #530
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
changed the steps sequence
WalkthroughRestructured the WhatsApp Groups Automation onboarding document: replaced the header with an HTML metadata table, reorganized setup into three explicit steps (Glific form, Maytapi linking, webhook connection), added webhook examples and domain guidance, expanded post-setup UI/use and Pricing/Video Showcase sections. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
|
🚀 Deployed on https://deploy-preview-530--glific-docs.netlify.app |
There was a problem hiding this 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (4)
14-14: Fix incorrect TOC numbering.Line 14 lists
8. [Pricing]but should be3. [Pricing]to reflect the three main sections (Pre-requisites, Set-up, Pricing).-8. [Pricing](#pricing) +3. [Pricing](#pricing)
17-18: Fix Pre-requisites numbering.Line 17 starts with
1.and line 18 jumps to3.without2., breaking the list sequence.1. Have an active phone number with a normal WhatsApp account linked to it. -3. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner) +2. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner)
48-48: Fix grammar: "my" → "by".Line 48: "check if the product and token id as provided my Maytapi" should be "provided by Maytapi".
-2. In Glific, go to setting, go to maytapi, and check if the product and token id as provided my Maytapi is added. +2. In Glific, go to setting, go to maytapi, and check if the product and token id as provided by Maytapi is added.
64-64: Fix typo: "assocaited" → "associated".Line 64: "assocaited" should be "associated".
-1. Glific supports only 1 Maytapi linked phone number to be assocaited with the platform at present. +1. Glific supports only 1 Maytapi linked phone number to be associated with the platform at present.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md(2 hunks)
🔇 Additional comments (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (1)
1-9: Verify HTML/JSX syntax compatibility in markdown.The inline style on line 5 uses JSX syntax (
style={{ paddingLeft: '40px' }}) rather than standard HTML (style="padding-left: 40px;"). Confirm this renders correctly in your documentation pipeline; if not, switch to standard HTML.- <td style={{ paddingLeft: '40px' }}><b>Level: Beginner </b></td> - <td style={{ paddingLeft: '40px' }}><b>Last Updated: December 2025</b></td> + <td style="padding-left: 40px;"><b>Level: Beginner </b></td> + <td style="padding-left: 40px;"><b>Last Updated: December 2025</b></td>
tanuprasad530
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The app name + gupshup API key is not mentioned in the documentation linked. So, this instruction should be included as sub-steps.
|
@tanuprasad530 - As explained on the call Gupshup app name and api key is not required now. You can go ahead and merge the PR. |
re-worded and removed the not needed steps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (1)
63-63: Fix spelling error.Line 63: "assocaited" should be "associated".
🔎 Proposed fix
- 1. Glific supports only 1 Maytapi linked phone number to be assocaited with the platform at present. + 1. Glific supports only 1 Maytapi linked phone number to be associated with the platform at present.
🧹 Nitpick comments (2)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (2)
30-32: Format bare URLs as Markdown links.Lines 30 and 32 contain bare URLs that should be formatted as Markdown links for better readability and consistency.
🔎 Proposed fixes
- 1. Create maytapi account https://console.maytapi.com/login + 1. Create maytapi account on [Maytapi Console](https://console.maytapi.com/login) - 3. Set up the payment option (~30$ per phone per month) in Maytapi. (For difficulties with the payments reach out directly to Maytapi team on info@maytapi.com keeping your Glific team POC in loop.) + 3. Set up the payment option (~30$ per phone per month) in Maytapi. (For difficulties with the payments reach out directly to Maytapi team at [info@maytapi.com](mailto:info@maytapi.com) keeping your Glific team POC in loop.)
49-52: Clarify post-setup user experience documentation.The text "You should be able to see the whatsapp groups option in the left panel..." appears after "This completes the set-up" but is separated from the final setup step. Consider reorganizing this section with a clear heading (e.g., "### After Setup: Using WhatsApp Groups") to improve document structure.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md
🧰 Additional context used
🪛 LanguageTool
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md
[uncategorized] ~31-~31: The name of this company should be capitalized.
Context: ...onsole.maytapi.com/login 2. Log in with google id and link a phone number (follow inst...
(GOOGLE_PRODUCTS)
[grammar] ~34-~34: 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/Onboarding for new NGOs.md
30-30: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
| <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: December 2025</b></td> | ||
| </tr> | ||
| </table> | ||
| </h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix JSX-like syntax in HTML table – not valid in Markdown.
The inline style attribute uses JSX syntax style={{ paddingLeft: '40px' }} which is not valid HTML/Markdown. Use standard CSS inline styles or convert to a Markdown table.
🔎 Proposed fixes
Option 1: Use standard HTML CSS inline styles
-<table>
+<table style="width: 100%; border-collapse: collapse;">
<tr>
- <td><b>5 minutes read</b></td>
- <td style={{ paddingLeft: '40px' }}><b>Level: Beginner </b></td>
- <td style={{ paddingLeft: '40px' }}><b>Last Updated: December 2025</b></td>
+ <td><b>5 minutes read</b></td>
+ <td style="padding-left: 40px;"><b>Level: Beginner</b></td>
+ <td style="padding-left: 40px;"><b>Last Updated: December 2025</b></td>
</tr>
</table>Option 2: Use a Markdown table
-<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: December 2025</b></td>
- </tr>
-</table>
-</h3>
+| | | |
+|---|---|---|
+| **5 minutes read** | **Level: Beginner** | **Last Updated: December 2025** |📝 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.
| <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: December 2025</b></td> | |
| </tr> | |
| </table> | |
| </h3> | |
| <h3> | |
| <table style="width: 100%; border-collapse: collapse;"> | |
| <tr> | |
| <td><b>5 minutes read</b></td> | |
| <td style="padding-left: 40px;"><b>Level: Beginner</b></td> | |
| <td style="padding-left: 40px;"><b>Last Updated: December 2025</b></td> | |
| </tr> | |
| </table> | |
| </h3> |
🤖 Prompt for AI Agents
In docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md around lines 1
to 9, the HTML table contains JSX-style inline styles (style={{ paddingLeft:
'40px' }}) which is invalid in Markdown/HTML; fix by replacing JSX syntax with
valid HTML inline CSS (e.g., style="padding-left:40px;") for each td or by
converting the entire table to a proper Markdown table format, ensuring spacing
and bold text are preserved and removing any JSX-specific braces and quotes.
| #### Step 2: Linking phone number to Maytapi account | ||
|
|
||
|
|
||
| 1. Create maytapi account https://console.maytapi.com/login | ||
| 2. Log in with google id and link a phone number (follow instructions given on Maytapi page) | ||
| 3. Set up the payment option (~30$ per phone per month) in Maytapi. (For difficulties with the payments reach out directly to Maytapi team on info@maytapi.com keeping your Glific team POC in loop.) | ||
| 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. | ||
|
|
||
| <img width="1276" alt="Screenshot 2024-11-18 at 3 52 57 PM" src="https://github.com/user-attachments/assets/408e6382-4c49-4a6c-ab51-67c185ff59b7" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix critical typo in Maytapi platform name and minor text quality issues.
- Line 34: "Maytpayi" should be "Maytapi"
- Line 31: "google id" should be "Google ID" (product name capitalization)
🔎 Proposed fixes
1. Create maytapi account https://console.maytapi.com/login
- 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)
3. Set up the payment option (~30$ per phone per month) in Maytapi. (For difficulties with the payments reach out directly to Maytapi team on info@maytapi.com keeping your Glific team POC in loop.)
4. Or proceed with free trial which disables the connection in 3 days.
- 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" given by Maytapi and then login to Glific account, go to settings >> Maytapi and paste the product id and token id and click on save.🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: The name of this company should be capitalized.
Context: ...onsole.maytapi.com/login 2. Log in with google id and link a phone number (follow inst...
(GOOGLE_PRODUCTS)
[grammar] ~34-~34: 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)
30-30: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md around lines 27
to 36, fix typos and capitalization: change "Maytpayi" to "Maytapi" on line 34
and change "google id" to "Google ID" on line 31; while there, tidy related
product/token wording to use consistent capitalization (e.g., "product ID" and
"token") and small grammar fixes such as "Create maytapi account" → "Create a
Maytapi account" to improve clarity.
changed the steps sequence
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.