Update and rename 02. Setup an organisation on GupShup.md to 02. Gups… #433
Conversation
…hup Setup .md changed the name added more details
WalkthroughUpdated the Gupshup Setup documentation: metadata revised; content reorganized into Introduction, Prerequisites, and a new Process Overview; images and links replaced; new sections added for Configure Read Receipts, Add Display Picture, and FAQ; steps renumbered and formatting standardized. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/2. Pre Onboarding/02. Gupshup Setup .md (2)
13-33: Tidy Markdown to satisfy lint checks.
### Introductionhas double spaces after the hashes, triggering MD019 (no-multiple-space-atx). Please collapse the extra spaces so the heading renders cleanly and the linter passes.
221-226: Use descriptive link text.The linter (MD059) flags bare “here” links. Rephrase the sentences so the clickable text summarizes the destination (e.g., “Read the display-name guidelines on Meta Business Help Center”).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup .md(4 hunks)
🧰 Additional context used
🪛 GitHub Actions: Build and Deploy to Netlify
docs/2. Pre Onboarding/02. Gupshup Setup .md
[error] 1-1: Docusaurus build failed. Unable to compute a valid slug for document 'Gupshup Setup' in '2. Pre Onboarding'. The computed slug '/Pre Onboarding/Gupshup Setup ' is invalid. Add a valid slug in front matter (e.g., slug: /my/customDocPath). Command 'yarn build' exited with code 1.
🪛 GitHub Actions: Test deployment
docs/2. Pre Onboarding/02. Gupshup Setup .md
[error] 1-1: Docusaurus build failed due to invalid slug: The slug computed for document ID "Gupshup Setup " in "2. Pre Onboarding" directory is invalid (looks like '/Pre Onboarding/Gupshup Setup '). Fix the front matter slug or file path to a valid slug. Command: yarn build
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup .md
13-13: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
221-221: Link text should be descriptive
(MD059, descriptive-link-text)
225-225: Link text should be descriptive
(MD059, descriptive-link-text)
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (6)
docs/2. Pre Onboarding/02. Gupshup Setup.md (6)
13-13: Fix heading spacing (MD019).Remove the extra space after the hashes.
-### Introduction +### Introduction
24-33: Clarify prerequisites and fix grammar/nesting.Capitalize SIM/SMS, fix “disassociate”, and format sub‑steps.
-- A new phone number or a phone number that hasn’t been used with WhatsApp. The sim card should be activated with a minimal plan so as to receive sms verification code/call from Gupshup +- A new phone number, or a number that hasn’t been used with WhatsApp. The SIM card should be active with a minimal plan to receive the SMS verification code/call from Gupshup. - -- To dis-associate your phone number from WhatsApp you need to open WhatsApp on your phone. - Go to Settings → Account → Delete my account. - - Note - simply uninstalling the app **does not** remove the association between the phone number and WhatsApp. +- To disassociate your phone number from WhatsApp: + - Open WhatsApp on your phone. + - Go to Settings → Account → Delete my account. + - Note: simply uninstalling the app **does not** remove the association between the phone number and WhatsApp.
34-36: List numbering robustness.Consider using “1.” for all ordered list items so Markdown auto-numbers them, avoiding duplicate/misaligned steps later.
41-43: Use HTTPS and canonical Gupshup domain.Prefer HTTPS and the official domain.
-1. Go to [Gupshup.ai](http://Gupshup.ai) and click on sign up +1. Go to [Gupshup](https://www.gupshup.io/) and click on Sign upIf your org standard is a different official URL, update accordingly.
211-221: Make link text descriptive (MD059).Avoid “here” as anchor text.
-- Read more about display names and verification [here](https://support.gupshup.io/hc/en-us/articles/360012076019-How-to-get-a-verified-tick-How-will-my-display-name-show-to-end-users). +- Read more: [How to get a verified tick and how display names appear](https://support.gupshup.io/hc/en-us/articles/360012076019-How-to-get-a-verified-tick-How-will-my-display-name-show-to-end-users).
223-226: Make link text descriptive (MD059).Replace “here” with a meaningful title.
-- Follow the steps outlined [here](https://support.gupshup.io/hc/en-us/articles/360012076019-How-to-get-a-verified-tick-How-will-my-display-name-show-to-end-users) +- Follow: [Steps to apply for the WhatsApp Green Tick](https://support.gupshup.io/hc/en-us/articles/360012076019-How-to-get-a-verified-tick-How-will-my-display-name-show-to-end-users)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md(4 hunks)
🧰 Additional context used
🪛 GitHub Actions: Build and Deploy to Netlify
docs/2. Pre Onboarding/02. Gupshup Setup.md
[error] 3-3: MDX compilation failed during Docusaurus build. Cause: Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🪛 GitHub Actions: Test deployment
docs/2. Pre Onboarding/02. Gupshup Setup.md
[error] 3-3: MDX compilation failed. Cause: Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup.md
13-13: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
221-221: Link text should be descriptive
(MD059, descriptive-link-text)
225-225: Link text should be descriptive
(MD059, descriptive-link-text)
| <h3> | ||
| <table> <tr> <td> | ||
| <b>10 minutes read</b></td> <td style={{ paddingLeft: '40px' }}><b>Level: Beginner</b></td> <td style={{ paddingLeft: '40px' }}><b>Last Updated: October 2025</b></td> </tr> </table> </h3> |
There was a problem hiding this comment.
Fix MDX header HTML (breaks build).
The inline <table> inside <h3> with JSX style={{…}} causes MDX compilation failure. Replace with plain Markdown.
-<h3>
- <table> <tr> <td>
- <b>10 minutes read</b></td> <td style={{ paddingLeft: '40px' }}><b>Level: Beginner</b></td> <td style={{ paddingLeft: '40px' }}><b>Last Updated: October 2025</b></td> </tr> </table> </h3>
+| 10 minutes read | Level: Beginner | Last updated: October 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>10 minutes read</b></td> <td style={{ paddingLeft: '40px' }}><b>Level: Beginner</b></td> <td style={{ paddingLeft: '40px' }}><b>Last Updated: October 2025</b></td> </tr> </table> </h3> | |
| | 10 minutes read | Level: Beginner | Last updated: October 2025 | | |
| | --- | --- | --- | |
🧰 Tools
🪛 GitHub Actions: Build and Deploy to Netlify
[error] 3-3: MDX compilation failed during Docusaurus build. Cause: Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🪛 GitHub Actions: Test deployment
[error] 3-3: MDX compilation failed. Cause: Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🤖 Prompt for AI Agents
In docs/2. Pre Onboarding/02. Gupshup Setup.md around lines 1 to 3, the MDX
header embeds raw HTML/JSX (<table> with style={{…}}) which breaks the MDX
build; replace that HTML block with plain Markdown — e.g., remove the <h3> and
<table> HTML and convert the content into a simple Markdown heading and inline
bold metadata (or a small bullet/list) such as a level-3 or level-2 Markdown
heading for the title followed by plain text or bolded metadata lines for "10
minutes read", "Level: Beginner", and "Last Updated: October 2025" so the file
contains valid MDX without JSX/HTML tables.
| Gupshup is the official WhatsApp Business API provider (BSP) used by Glific. All WhatsApp communication for your chatbot flows through Gupshup’s platform. | ||
| Gupshup setup is required for the below resons: | ||
| - Meta (Facebook) mandates that businesses connect through a verified BSP. | ||
| - Gupshup provides the interface for creating a WhatsApp Business Account (WABA), managing templates, and ensuring compliance. | ||
| - Without completing the Gupshup setup, your chatbot cannot go live on WhatsApp. |
There was a problem hiding this comment.
Typo and phrasing.
“resons” → “reasons” and smoother phrasing.
-Gupshup setup is required for the below resons:
+Gupshup setup is required for the following reasons:📝 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.
| Gupshup is the official WhatsApp Business API provider (BSP) used by Glific. All WhatsApp communication for your chatbot flows through Gupshup’s platform. | |
| Gupshup setup is required for the below resons: | |
| - Meta (Facebook) mandates that businesses connect through a verified BSP. | |
| - Gupshup provides the interface for creating a WhatsApp Business Account (WABA), managing templates, and ensuring compliance. | |
| - Without completing the Gupshup setup, your chatbot cannot go live on WhatsApp. | |
| Gupshup is the official WhatsApp Business API provider (BSP) used by Glific. All WhatsApp communication for your chatbot flows through Gupshup’s platform. | |
| Gupshup setup is required for the following reasons: | |
| - Meta (Facebook) mandates that businesses connect through a verified BSP. | |
| - Gupshup provides the interface for creating a WhatsApp Business Account (WABA), managing templates, and ensuring compliance. | |
| - Without completing the Gupshup setup, your chatbot cannot go live on WhatsApp. |
🤖 Prompt for AI Agents
In docs/2. Pre Onboarding/02. Gupshup Setup.md around lines 15 to 19, fix the
typo "resons" to "reasons" and smooth the phrasing of the second sentence;
rewrite "Gupshup setup is required for the below resons:" to "Gupshup setup is
required for the following reasons:" and ensure the rest of the paragraph reads
fluently (e.g., keep bullets but adjust punctuation/spacing for clarity).
| ## Configure Read Receipts in the Gupshup Account | ||
|
|
||
|  | ||
| Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account./) for detailed steps. | ||
|
|
||
| 34 . Turn off the **automated opt-in message** option (refer to the image below ), so that users will not get optin message when they send the message for the first time. Glific provides an easier way to get optin preferences from a flow. Refer [Configure Optin & Optout preferences in Glific](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Configure%20Optin%20&%20Optout%20preferences%20in%20Glific/) for more details. | ||
| If you're done with this step and want to get started with Glific, you may also [check out the onboarding steps here](https://glific.github.io/docs/docs/Onboarding/Glific%20Onboarding%20Toolkit). | ||
|
|
There was a problem hiding this comment.
Broken internal link (trailing dot).
The FAQ link has an extra dot before the trailing slash, likely 404.
-Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account./) for detailed steps.
+Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account/) for detailed steps.Note: The same issue appears earlier in step 26 (line 180); please fix there too.
📝 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.
| ## Configure Read Receipts in the Gupshup Account | |
|  | |
| Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account./) for detailed steps. | |
| 34 . Turn off the **automated opt-in message** option (refer to the image below ), so that users will not get optin message when they send the message for the first time. Glific provides an easier way to get optin preferences from a flow. Refer [Configure Optin & Optout preferences in Glific](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Configure%20Optin%20&%20Optout%20preferences%20in%20Glific/) for more details. | |
| If you're done with this step and want to get started with Glific, you may also [check out the onboarding steps here](https://glific.github.io/docs/docs/Onboarding/Glific%20Onboarding%20Toolkit). | |
| ## Configure Read Receipts in the Gupshup Account | |
| Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account/) for detailed steps. | |
| If you're done with this step and want to get started with Glific, you may also [check out the onboarding steps here](https://glific.github.io/docs/docs/Onboarding/Glific%20Onboarding%20Toolkit). |
🤖 Prompt for AI Agents
In docs/2. Pre Onboarding/02. Gupshup Setup.md around lines 201-206 (and also
fix the earlier occurrence around line 180), the internal FAQ link contains an
extra dot before the trailing slash causing a 404; remove the stray dot from the
URL path so the link becomes
https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account/
(update both occurrences), verify the markdown renders and the link opens the
intended FAQ page.
removed broken links
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/2. Pre Onboarding/02. Gupshup Setup.md (2)
1-3: Remove HTML table to fix MDX blocker.The inline
<table>inside the<h3>still breaks MDX compilation (see failing Netlify build). Please replace this block with plain Markdown—e.g., a simple heading followed by a Markdown table or bullet list for the metadata.
13-16: Fix typo in prerequisites intro.“resons” should be “reasons” so the sentence reads smoothly.
🧹 Nitpick comments (3)
docs/2. Pre Onboarding/02. Gupshup Setup.md (3)
13-13: Drop extra space in heading.
### Introductionuses two spaces after the hashes and trips MD019; trim to a single space.
207-207: Tighten link text spacing.
[add display picture ]has a trailing space inside the brackets; remove it to satisfy MD039.
221-225: Make link text descriptive.Anchors labeled “here” violate MD059 and are vague. Replace with descriptive text such as “Read more about display names and verification in Gupshup support”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md(4 hunks)
🧰 Additional context used
🪛 GitHub Actions: Build and Deploy to Netlify
docs/2. Pre Onboarding/02. Gupshup Setup.md
[error] 3-3: MDX compilation failed for file '/home/runner/work/docs/docs/docs/2. Pre Onboarding/02. Gupshup Setup.md'. Cause: Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🪛 GitHub Actions: Test deployment
docs/2. Pre Onboarding/02. Gupshup Setup.md
[error] 3-3: MDX compilation failed. Expected the closing tag either after the end of paragraph (3:196) or another opening tag after the start of paragraph (3:9).
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup.md
13-13: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
207-207: Spaces inside link text
(MD039, no-space-in-links)
221-221: Link text should be descriptive
(MD059, descriptive-link-text)
225-225: Link text should be descriptive
(MD059, descriptive-link-text)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs/2. Pre Onboarding/02. Gupshup Setup.md (3)
186-189: Correct the FAQ link URL (404).The link still contains an extra dot before the trailing slash, so it 404s. Please remove the stray dot (and update any other occurrence).
-26. Configure read receipts in the Gupshup account. Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account./) for detailed steps. +26. Configure read receipts in the Gupshup account. Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account/) for detailed steps.
1-9: Replace the HTML header with plain Markdown.Embedding a
<table>inside<h3>still breaks MDX compilation (see the failing Netlify build). Please convert the metadata to plain Markdown so the page renders and the build succeeds.-<h3> - <table> - <tr> - <td><b>10 minutes read</b></td> - <td style="padding-left: 40px;"><b>Level: Beginner</b></td> - <td style="padding-left: 40px;"><b>Last Updated: October 2025</b></td> - </tr> - </table> -</h3> - -___ +| 10 minutes read | Level: Beginner | Last updated: October 2025 | +| --- | --- | --- | + +---
22-24: Fix the typo in the introductory paragraph.“resons” should be “reasons,” and the sentence reads better with “following reasons.”
-Gupshup setup is required for the below resons: +Gupshup setup is required for the following reasons:
🧹 Nitpick comments (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md (1)
213-214: Tighten the link label spacing.Markdown lint flags the trailing space inside the link text; dropping it keeps CI clean.
-Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) +Please refer to [add display picture](https://docs.gupshup.io/docs/profile)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup.md
19-19: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
213-213: Spaces inside link text
(MD039, no-space-in-links)
227-227: Link text should be descriptive
(MD059, descriptive-link-text)
231-231: Link text should be descriptive
(MD059, descriptive-link-text)
|
🚀 Deployed on https://deploy-preview-433--glific-docs.netlify.app |
There was a problem hiding this comment.
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 (2)
docs/2. Pre Onboarding/02. Gupshup Setup.md (2)
103-105: Correct “dashboarad” typo.Line 103 has “dashboarad”; update it to “dashboard” for clarity.
-11. Go to dashboarad and then click on the `Go live` button beside your app. +11. Go to dashboard and then click on the `Go live` button beside your app.
187-188: Fix typo in step 27.“Please refere” should be “Please refer”, and add the missing space after the period.
-27. Upload a display picture so it can be visible to your end users.Please refere [Update my profile picture of BOT](https://glific.github.io/docs/docs/FAQ/Update%20my%20profile%20picture%20of%20BOT/) +27. Upload a display picture so it can be visible to your end users. Please refer to [Update my profile picture of BOT](https://glific.github.io/docs/docs/FAQ/Update%20my%20profile%20picture%20of%20BOT/).
♻️ Duplicate comments (3)
docs/2. Pre Onboarding/02. Gupshup Setup.md (3)
185-187: Fix FAQ link URL (extra dot).The read-receipts link still contains
account./, which 404s. Remove the stray dot (also noted in the previous review).-Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account./) for detailed steps. +Please refer to [Configure read receipts in Gupshup account](https://glific.github.io/docs/docs/FAQ/Configure%20read%20receipts%20in%20Gupshup%20account/) for detailed steps.
1-8: Remove HTML table header (breaks MDX build).The
<h3>+<table>block withstyle={{…}}is JSX/HTML that fails MDX compilation (same issue flagged earlier). Replace it with plain Markdown so the page renders.-<h3> - <table> - <tr> - <td><b>10 minutes read</b></td> - <td style={{ paddingLeft: '40px' }}><b>Level: Beginner </b></td> - <td style={{ paddingLeft: '40px' }}><b>Last Updated: October 2025</b></td> - </tr> -</table> -</h3> +| 10 minutes read | Level: Beginner | Last updated: October 2025 | +| --- | --- | --- |
18-24: Fix typo and wording in introduction.Please correct “resons” → “reasons” and smooth the sentence as suggested in the earlier review.
-Gupshup setup is required for the below resons: +Gupshup setup is required for the following reasons:
🧹 Nitpick comments (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md (1)
18-18: Remove extra space after heading hashes.Markdownlint (MD019) flags the double space in
### Introduction; trim it to a single space for consistent headings.-### Introduction +### Introduction
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup.md
18-18: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
212-212: Spaces inside link text
(MD039, no-space-in-links)
226-226: Link text should be descriptive
(MD059, descriptive-link-text)
230-230: Link text should be descriptive
(MD059, descriptive-link-text)
…hup Setup .md
changed the name added more details
Summary by CodeRabbit