Document onboarding process for new Glific chatbot#579
Open
SangeetaMishr wants to merge 2 commits intomainfrom
Open
Document onboarding process for new Glific chatbot#579SangeetaMishr wants to merge 2 commits intomainfrom
SangeetaMishr wants to merge 2 commits intomainfrom
Conversation
Added detailed instructions for onboarding a new chatbot in Glific, including steps for Gupshup app setup and connecting to Glific.
Contributor
📝 WalkthroughWalkthroughThis pull request adds a new documentation page with end-to-end onboarding instructions for adding a second chatbot to Glific, covering phone number selection, Gupshup app setup, API key collection, Glific settings integration, webhook enablement, and verification, with step-by-step screenshots. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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-579--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 9
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md:
- Line 22: Fix the punctuation in the sentence "**Important:** Do not install
WhatsApp on this number.If using an existing number, uninstall WhatsApp from it
before connecting to the bot." by inserting a space after the period so it reads
"...number. If using an existing number..." — update the line in the "Adding a
New Chatbot in Glific.md" content where that exact sentence appears.
- Line 56: Fix the typo in the sentence "Go to dashboarad and then click on the
`Go live` button beside your app." by replacing "dashboarad" with "dashboard" so
the line reads "Go to dashboard and then click on the `Go live` button beside
your app." Update the Markdown content in the Adding a New Chatbot in Glific
section accordingly.
- Line 70: Fix the typographical spacing in the documentation line that reads
"`Next`button" by inserting a space so it becomes "`Next` button"; locate the
exact string "`Next`button" in the document "Adding a New Chatbot in Glific.md"
and update it to "`Next` button" to ensure proper spacing and readability.
- Line 132: Change the incorrect singular "Congratulation!" to the plural
"Congratulations!" in the sentence "Congratulation! You are now ready to send
messages. Select Go to dashboard and your Gupshup App will be `Live`." so the
line reads "Congratulations! You are now ready to send messages. Select Go to
dashboard and your Gupshup App will be `Live`."
- Line 65: Replace the unclear phrase "WhatsApp free" in the sentence "Review
the `data storage region`, the respective country's WhatsApp free, and select
`Proceed`." with "WhatsApp fees" and adjust punctuation to read naturally (e.g.,
"Review the `data storage region`, the respective country's WhatsApp fees, and
select `Proceed`.") so the meaning is clear and grammatically correct.
- Line 26: The sentence containing "You will receive the Onboarding Form link
from the Glific Team. You can refer to this documentation for guidance on how to
complete the form." is missing a hyperlink on the phrase "this documentation";
update the Markdown in "Adding a New Chatbot in Glific.md" to replace "this
documentation" with a proper Markdown link pointing to the intended onboarding
guidance URL (e.g., [this documentation](URL)), ensuring the anchor text remains
"this documentation" and the URL is the correct target for the onboarding form
guidance.
- Line 147: The markdown link text "[add display picture ]" contains a trailing
space before the closing bracket causing MD039; remove the trailing space so the
link text reads "[add display picture]" (keep the target URL unchanged) to
resolve the lint error.
- Line 30: Fix the typos and grammar in the sentence that starts "Each chatbot
needs a separate Gupshup app. As Facebook account..." by replacing "acocunt"
with "account", "GUpshuyp" with "Gupshup", changing the noun "Login" to the verb
phrase "log in", adding the missing space after the period, and rephrasing the
awkward clause to read: "Each chatbot needs a separate Gupshup app. As the
Facebook account is already verified, there is no need to redo that. Make sure
to log in to your verified Facebook account while performing the Gupshup app
live process."
- Line 32: Update the insecure and incorrect Gupshup link: replace the text "Log
in to Gupshup.ai" and its URL using the insecure http scheme with the secure
corporate self-serve console URL "https://www.gupshup.io/" (use https and the
gupshup.io domain) so the instructional line points to the correct, secure
Gupshup console.
|
|
||
| - Get a phone number for this bot. | ||
|
|
||
| - **Important:** Do not install WhatsApp on this number.If using an existing number, uninstall WhatsApp from it before connecting to the bot. |
Contributor
There was a problem hiding this comment.
Missing space after period.
✏️ Proposed fix
-- **Important:** Do not install WhatsApp on this number.If using an existing number, uninstall WhatsApp from it before connecting to the bot.
+- **Important:** Do not install WhatsApp on this number. If using an existing number, uninstall WhatsApp from it before connecting to the bot.📝 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
| - **Important:** Do not install WhatsApp on this number.If using an existing number, uninstall WhatsApp from it before connecting to the bot. | |
| - **Important:** Do not install WhatsApp on this number. If using an existing number, uninstall WhatsApp from it before connecting to the bot. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 22, Fix the
punctuation in the sentence "**Important:** Do not install WhatsApp on this
number.If using an existing number, uninstall WhatsApp from it before connecting
to the bot." by inserting a space after the period so it reads "...number. If
using an existing number..." — update the line in the "Adding a New Chatbot in
Glific.md" content where that exact sentence appears.
|
|
||
| ### Step 2: Filling the Glific onboarding form: | ||
|
|
||
| - You will receive the Onboarding Form link from the Glific Team. You can refer to this documentation for guidance on how to complete the form. |
Contributor
There was a problem hiding this comment.
"this documentation" is missing its hyperlink.
The phrase "refer to this documentation" has no URL attached, leaving the user with no path to the referenced content.
✏️ Proposed fix
-- You will receive the Onboarding Form link from the Glific Team. You can refer to this documentation for guidance on how to complete the form.
++ You will receive the Onboarding Form link from the Glific Team. You can refer to [this documentation](<INSERT_LINK_HERE>) for guidance on how to complete the form.📝 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
| - You will receive the Onboarding Form link from the Glific Team. You can refer to this documentation for guidance on how to complete the form. | |
| - You will receive the Onboarding Form link from the Glific Team. You can refer to [this documentation](<INSERT_LINK_HERE>) for guidance on how to complete the form. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 26, The
sentence containing "You will receive the Onboarding Form link from the Glific
Team. You can refer to this documentation for guidance on how to complete the
form." is missing a hyperlink on the phrase "this documentation"; update the
Markdown in "Adding a New Chatbot in Glific.md" to replace "this documentation"
with a proper Markdown link pointing to the intended onboarding guidance URL
(e.g., [this documentation](URL)), ensuring the anchor text remains "this
documentation" and the URL is the correct target for the onboarding form
guidance.
|
|
||
| ### Step 3: Gupshup App Setup (Required) | ||
|
|
||
| - Each chatbot needs a separate Gupshup app. As Facebook account is already verified, so no need to redo that.Make sure to Login to your verified Facebook acocunt while doing the GUpshuyp app live process. |
Contributor
There was a problem hiding this comment.
Multiple typos and grammar issues on this line (also flagged by static analysis).
acocunt→accountGUpshuyp→GupshupLogin(noun) →log in(verb)- Missing space after the period before
Make - "As Facebook account is already verified, so no need to redo that." is grammatically awkward
✏️ Proposed fix
-- Each chatbot needs a separate Gupshup app. As Facebook account is already verified, so no need to redo that.Make sure to Login to your verified Facebook acocunt while doing the GUpshuyp app live process.
+- Each chatbot needs a separate Gupshup app. Since your Facebook account is already verified, there is no need to redo that. Make sure to log in to your verified Facebook account while doing the Gupshup app live process.🧰 Tools
🪛 LanguageTool
[grammar] ~30-~30: Ensure spelling is correct
Context: ...sure to Login to your verified Facebook acocunt while doing the GUpshuyp app live proce...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 30, Fix the
typos and grammar in the sentence that starts "Each chatbot needs a separate
Gupshup app. As Facebook account..." by replacing "acocunt" with "account",
"GUpshuyp" with "Gupshup", changing the noun "Login" to the verb phrase "log
in", adding the missing space after the period, and rephrasing the awkward
clause to read: "Each chatbot needs a separate Gupshup app. As the Facebook
account is already verified, there is no need to redo that. Make sure to log in
to your verified Facebook account while performing the Gupshup app live
process."
|
|
||
| - Each chatbot needs a separate Gupshup app. As Facebook account is already verified, so no need to redo that.Make sure to Login to your verified Facebook acocunt while doing the GUpshuyp app live process. | ||
|
|
||
| - Log in to [Gupshup.ai](http://Gupshup.ai) |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Gupshup official login portal WhatsApp Business self-serve
💡 Result:
Gupshup’s official self-serve WhatsApp Business (API) console is accessed via the WhatsApp dashboard:
https://www.gupshup.io/whatsapp/dashboard
Log in there with your Gupshup credentials to manage apps / WhatsApp settings (Self-Serve). [1]
If you’re starting from the main site, use Gupshup’s Login on:
https://www.gupshup.io/
…and then proceed to the WhatsApp dashboard/self-serve flow. [2]
Sources: [1] [2]
🌐 Web query:
Gupshup.io vs Gupshup.ai domain official
💡 Result:
Both domains appear to be officially operated by Gupshup:
- gupshup.io is Gupshup’s long-standing corporate domain (listed as the company website in reference sources) and is still used in official materials (e.g., “visit: www.gupshup.io” and
@gupshup.iomedia contact emails). [1][2] - gupshup.ai is also official and is currently the primary website experience: visiting gupshup.io redirects to gupshup.ai, and the gupshup.ai site links to official docs hosted on docs.gupshup.io (same root domain control). [3][4]
If your goal is to avoid lookalikes/phishing: the safest sign is the direct redirect from gupshup.io → gupshup.ai and cross-linking to docs.gupshup.io. [3][4]
Fix insecure protocol and clarify Gupshup domain.
The link uses http:// instead of https://. Additionally, the correct Gupshup self-serve WhatsApp Business portal is at https://www.gupshup.io/, not gupshup.ai (both are official Gupshup domains, but gupshup.io is the corporate domain for the self-serve console).
✏️ Proposed fix
-- Log in to [Gupshup.ai](http://Gupshup.ai)
+- Log in to [Gupshup](https://www.gupshup.io/)📝 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
| - Log in to [Gupshup.ai](http://Gupshup.ai) | |
| - Log in to [Gupshup](https://www.gupshup.io/) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 32, Update
the insecure and incorrect Gupshup link: replace the text "Log in to Gupshup.ai"
and its URL using the insecure http scheme with the secure corporate self-serve
console URL "https://www.gupshup.io/" (use https and the gupshup.io domain) so
the instructional line points to the correct, secure Gupshup console.
|
|
||
|
|
||
|
|
||
| - Go to dashboarad and then click on the `Go live` button beside your app. |
Contributor
There was a problem hiding this comment.
Typo: "dashboarad" → "dashboard".
✏️ Proposed fix
-- Go to dashboarad and then click on the `Go live` button beside your app.
+- Go to dashboard and then click on the `Go live` button beside your app.📝 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
| - Go to dashboarad and then click on the `Go live` button beside your app. | |
| - Go to dashboard and then click on the `Go live` button beside your app. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 56, Fix the
typo in the sentence "Go to dashboarad and then click on the `Go live` button
beside your app." by replacing "dashboarad" with "dashboard" so the line reads
"Go to dashboard and then click on the `Go live` button beside your app." Update
the Markdown content in the Adding a New Chatbot in Glific section accordingly.
| <img width="768" alt="image" src="https://github.com/user-attachments/assets/ab3614a9-a68c-4cdf-8fc4-24ecc33ccb80" /> | ||
|
|
||
|
|
||
| - Review the `data storage region`, the respective country's WhatsApp free, and select `Proceed`. |
Contributor
There was a problem hiding this comment.
Unclear phrasing: "WhatsApp free" likely should be "WhatsApp fees".
✏️ Proposed fix
-- Review the `data storage region`, the respective country's WhatsApp free, and select `Proceed`.
+- Review the `data storage region`, the respective country's WhatsApp fees, and select `Proceed`.📝 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
| - Review the `data storage region`, the respective country's WhatsApp free, and select `Proceed`. | |
| - Review the `data storage region`, the respective country's WhatsApp fees, and select `Proceed`. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 65, Replace
the unclear phrase "WhatsApp free" in the sentence "Review the `data storage
region`, the respective country's WhatsApp free, and select `Proceed`." with
"WhatsApp fees" and adjust punctuation to read naturally (e.g., "Review the
`data storage region`, the respective country's WhatsApp fees, and select
`Proceed`.") so the meaning is clear and grammatically correct.
| <img width="894" alt="image" src="https://github.com/user-attachments/assets/e3b77607-a051-4bbc-a010-b2561361a15b" /> | ||
|
|
||
|
|
||
| - Enter the details of a contact person from your organization (It should be someone who would be managing chatbot work for the organization) & click `Next`button. |
Contributor
There was a problem hiding this comment.
Missing space between `Next` and "button".
✏️ Proposed fix
-- Enter the details of a contact person from your organization (It should be someone who would be managing chatbot work for the organization) & click `Next`button.
+- Enter the details of a contact person from your organization (It should be someone who would be managing chatbot work for the organization) and click the `Next` button.📝 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
| - Enter the details of a contact person from your organization (It should be someone who would be managing chatbot work for the organization) & click `Next`button. | |
| - Enter the details of a contact person from your organization (It should be someone who would be managing chatbot work for the organization) and click the `Next` button. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 70, Fix the
typographical spacing in the documentation line that reads "`Next`button" by
inserting a space so it becomes "`Next` button"; locate the exact string
"`Next`button" in the document "Adding a New Chatbot in Glific.md" and update it
to "`Next` button" to ensure proper spacing and readability.
|
|
||
| <img width="769" alt="image" src="https://github.com/user-attachments/assets/16533c4c-a074-405f-88aa-debfc169270f" /> | ||
|
|
||
| - Congratulation! You are now ready to send messages. Select Go to dashboard and your Gupshup App will be `Live`. |
Contributor
There was a problem hiding this comment.
Grammar: "Congratulation!" → "Congratulations!"
✏️ Proposed fix
-- Congratulation! You are now ready to send messages. Select Go to dashboard and your Gupshup App will be `Live`.
+- Congratulations! You are now ready to send messages. Select Go to dashboard and your Gupshup App will be `Live`.📝 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
| - Congratulation! You are now ready to send messages. Select Go to dashboard and your Gupshup App will be `Live`. | |
| - Congratulations! You are now ready to send messages. Select Go to dashboard and your Gupshup App will be `Live`. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 132, Change
the incorrect singular "Congratulation!" to the plural "Congratulations!" in the
sentence "Congratulation! You are now ready to send messages. Select Go to
dashboard and your Gupshup App will be `Live`." so the line reads
"Congratulations! You are now ready to send messages. Select Go to dashboard and
your Gupshup App will be `Live`."
|
|
||
|
|
||
|
|
||
| - Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) |
Contributor
There was a problem hiding this comment.
Remove trailing space inside link text (MD039).
[add display picture ] has a trailing space before the closing bracket, flagged by markdownlint.
✏️ Proposed fix
-- Please refer to [add display picture ](https://docs.gupshup.io/docs/profile)
+- Please refer to [add display picture](https://docs.gupshup.io/docs/profile)📝 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
| - Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) | |
| - Please refer to [add display picture](https://docs.gupshup.io/docs/profile) |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 147-147: Spaces inside link text
(MD039, no-space-in-links)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 147, The
markdown link text "[add display picture ]" contains a trailing space before the
closing bracket causing MD039; remove the trailing space so the link text reads
"[add display picture]" (keep the target URL unchanged) to resolve the lint
error.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (9)
docs/2. Pre Onboarding/Adding a New Chatbot in Glific.md (9)
147-147: Trailing space in link text — MD039 (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 147, The markdown link text contains a trailing space ("[add display picture ]") which triggers MD039; remove the trailing space so the link reads "[add display picture]" and ensure the URL remains unchanged ("https://docs.gupshup.io/docs/profile") to fix the lint error.
65-65: "WhatsApp free" → "WhatsApp fees" (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 65, Update the sentence that reads "Review the `data storage region`, the respective country's WhatsApp free, and select `Proceed`" by replacing the incorrect phrase `WhatsApp free` with `WhatsApp fees`; specifically edit the line containing the literal text `Review the `data storage region`, the respective country's WhatsApp free, and select `Proceed`.` to read `Review the `data storage region`, the respective country's WhatsApp fees, and select `Proceed`.`
70-70: Missing space between`Next`and "button" (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 70, Fix the spacing typo in the sentence that reads "`Next`button" by inserting a space so it becomes "`Next` button"; edit the line in the Adding a New Chatbot in Glific.md file where the contact person instruction contains the string "`Next`button" to read "`Next` button" ensuring correct spacing and punctuation.
26-26: "this documentation" missing its hyperlink (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 26, The phrase "this documentation" in the sentence "You will receive the Onboarding Form link from the Glific Team. You can refer to this documentation for guidance on how to complete the form." lacks a hyperlink; update that sentence by turning "this documentation" into an inline link pointing to the onboarding form guidance page (replace the plain text with a Markdown link), ensuring the anchor text remains "this documentation" and the link target is the correct onboarding guidance URL.
56-56: Typo "dashboarad" (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 56, Fix the typo "dashboarad" to "dashboard" in the sentence that reads "Go to dashboarad and then click on the `Go live` button beside your app." — update the document text to "Go to dashboard and then click on the `Go live` button beside your app." so the wording is correct and consistent with UI terminology.
132-132: "Congratulation!" → "Congratulations!" (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 132, Fix the typo in the documentation by replacing the sentence fragment "Congratulation! You are now ready to send messages." with "Congratulations! You are now ready to send messages."—locate the exact string "Congratulation!" in the doc (the line that ends with "Select Go to dashboard and your Gupshup App will be `Live`.") and update it to "Congratulations!" to correct the grammar.
30-30: Multiple typos and grammar issues (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 30, Fix the typos and grammar in the sentence "Each chatbot needs a separate Gupshup app. As Facebook account is already verified, so no need to redo that.Make sure to Login to your verified Facebook acocunt while doing the GUpshuyp app live process." by rephrasing for clarity and correctness (e.g., "Each chatbot requires a separate Gupshup app. Because your Facebook account is already verified, you do not need to re-verify it. Make sure to log in to your verified Facebook account when making the Gupshup app live."), correct capitalization of "Gupshup", "Facebook", "Login/log in", and spelling errors like "acocunt" and "GUpshuyp"; update the sentence in the "Adding a New Chatbot in Glific.md" document where that line appears.
32-32: Insecurehttp://URL and Gupshup domain concern (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 32, Replace the insecure and incorrect link text "Log in to [Gupshup.ai](http://Gupshup.ai)" with a secure, official domain using HTTPS (for example update the markdown to "Log in to [Gupshup](https://www.gupshup.io)" or the correct official domain). Locate the exact line containing the string "Log in to [Gupshup.ai](http://Gupshup.ai)" in the document and update both the visible label and the URL to use HTTPS and the verified Gupshup domain.
22-22: Missing space after period (already flagged).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 22, The sentence "- **Important:** Do not install WhatsApp on this number.If using an existing number, uninstall WhatsApp from it before connecting to the bot." is missing a space after the period; update the text in the Adding a New Chatbot in Glific.md (the "**Important:** Do not install WhatsApp on this number.If using an existing number..." line) to insert a space so it reads "...on this number. If using an existing number, uninstall WhatsApp..." to fix the punctuation spacing.
🧹 Nitpick comments (1)
docs/2. Pre Onboarding/Adding a New Chatbot in Glific.md (1)
177-177: Use a Docusaurus admonition for the note.Plain
Note:text is easy to miss. Since the site uses Docusaurus, the:::noteadmonition renders with a distinct callout box.✏️ Proposed fix
-Note: You do not need to add the App ID. It will be generated automatically in Glific. +:::note +You do not need to add the App ID. It will be generated automatically in Glific. +:::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 177, Replace the plain "Note: You do not need to add the App ID. It will be generated automatically in Glific." line with a Docusaurus admonition block so the note is rendered as a callout; locate the exact text and wrap it using the :::note admonition syntax (start a :::note line, put the message text inside, then close with :::) so the documentation renders the highlighted note correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md:
- Line 12: The heading "## Starting with another chatbot in Glific " contains a
trailing space; open the file and remove the extra space so the heading reads
"## Starting with another chatbot in Glific" (locate that exact heading text in
docs/2. Pre Onboarding/Adding a New Chatbot in Glific.md and trim the trailing
whitespace).
- Line 150: The heading "Connecting Gupshup to Glific" breaks the established
step-heading convention; change it from an unnumbered "### Connecting Gupshup to
Glific:" to the numbered format used elsewhere (e.g., "### Step 4: Connecting
Gupshup to Glific:") so it follows the `### Step N: …` pattern used in Steps 1–3
and keeps numbering consistent across the document.
- Line 24: The heading "### Step 2: Filling the Glific onboarding form:" is
inconsistent with Steps 1 and 3 and has an unnecessary trailing colon; update
this heading to match the style of the others (use an imperative verb and remove
the trailing colon), e.g. change "### Step 2: Filling the Glific onboarding
form:" to "### Step 2: Fill the Glific onboarding form" so it aligns with the
phrasing and punctuation used in Step 1 and Step 3.
- Around line 34-41: The continuation prose following the bullet "Enter an app
name (No space or special characters allowed)." is not indented and breaks the
list; fix it by indenting that paragraph (or prefixing it with "- ") so the
sentence starting "This is something internal and not visible to your end users
& also **it cannot be changed once setup is completed**." remains part of the
same list item; apply the same indentation to the example app names line and the
screenshot caption so they stay under the "Enter an app name" bullet.
---
Duplicate comments:
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md:
- Line 147: The markdown link text contains a trailing space ("[add display
picture ]") which triggers MD039; remove the trailing space so the link reads
"[add display picture]" and ensure the URL remains unchanged
("https://docs.gupshup.io/docs/profile") to fix the lint error.
- Line 65: Update the sentence that reads "Review the `data storage region`, the
respective country's WhatsApp free, and select `Proceed`" by replacing the
incorrect phrase `WhatsApp free` with `WhatsApp fees`; specifically edit the
line containing the literal text `Review the `data storage region`, the
respective country's WhatsApp free, and select `Proceed`.` to read `Review the
`data storage region`, the respective country's WhatsApp fees, and select
`Proceed`.`
- Line 70: Fix the spacing typo in the sentence that reads "`Next`button" by
inserting a space so it becomes "`Next` button"; edit the line in the Adding a
New Chatbot in Glific.md file where the contact person instruction contains the
string "`Next`button" to read "`Next` button" ensuring correct spacing and
punctuation.
- Line 26: The phrase "this documentation" in the sentence "You will receive the
Onboarding Form link from the Glific Team. You can refer to this documentation
for guidance on how to complete the form." lacks a hyperlink; update that
sentence by turning "this documentation" into an inline link pointing to the
onboarding form guidance page (replace the plain text with a Markdown link),
ensuring the anchor text remains "this documentation" and the link target is the
correct onboarding guidance URL.
- Line 56: Fix the typo "dashboarad" to "dashboard" in the sentence that reads
"Go to dashboarad and then click on the `Go live` button beside your app." —
update the document text to "Go to dashboard and then click on the `Go live`
button beside your app." so the wording is correct and consistent with UI
terminology.
- Line 132: Fix the typo in the documentation by replacing the sentence fragment
"Congratulation! You are now ready to send messages." with "Congratulations! You
are now ready to send messages."—locate the exact string "Congratulation!" in
the doc (the line that ends with "Select Go to dashboard and your Gupshup App
will be `Live`.") and update it to "Congratulations!" to correct the grammar.
- Line 30: Fix the typos and grammar in the sentence "Each chatbot needs a
separate Gupshup app. As Facebook account is already verified, so no need to
redo that.Make sure to Login to your verified Facebook acocunt while doing the
GUpshuyp app live process." by rephrasing for clarity and correctness (e.g.,
"Each chatbot requires a separate Gupshup app. Because your Facebook account is
already verified, you do not need to re-verify it. Make sure to log in to your
verified Facebook account when making the Gupshup app live."), correct
capitalization of "Gupshup", "Facebook", "Login/log in", and spelling errors
like "acocunt" and "GUpshuyp"; update the sentence in the "Adding a New Chatbot
in Glific.md" document where that line appears.
- Line 32: Replace the insecure and incorrect link text "Log in to
[Gupshup.ai](http://Gupshup.ai)" with a secure, official domain using HTTPS (for
example update the markdown to "Log in to [Gupshup](https://www.gupshup.io)" or
the correct official domain). Locate the exact line containing the string "Log
in to [Gupshup.ai](http://Gupshup.ai)" in the document and update both the
visible label and the URL to use HTTPS and the verified Gupshup domain.
- Line 22: The sentence "- **Important:** Do not install WhatsApp on this
number.If using an existing number, uninstall WhatsApp from it before connecting
to the bot." is missing a space after the period; update the text in the Adding
a New Chatbot in Glific.md (the "**Important:** Do not install WhatsApp on this
number.If using an existing number..." line) to insert a space so it reads
"...on this number. If using an existing number, uninstall WhatsApp..." to fix
the punctuation spacing.
---
Nitpick comments:
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md:
- Line 177: Replace the plain "Note: You do not need to add the App ID. It will
be generated automatically in Glific." line with a Docusaurus admonition block
so the note is rendered as a callout; locate the exact text and wrap it using
the :::note admonition syntax (start a :::note line, put the message text
inside, then close with :::) so the documentation renders the highlighted note
correctly.
| </h3> | ||
|
|
||
|
|
||
| ## Starting with another chatbot in Glific |
Contributor
There was a problem hiding this comment.
Trailing space in heading.
The heading has a trailing space after "Glific ". While typically harmless in rendering, it violates clean Markdown hygiene.
✏️ Proposed fix
-## Starting with another chatbot in Glific
+## Starting with another chatbot in Glific🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 12, The
heading "## Starting with another chatbot in Glific " contains a trailing space;
open the file and remove the extra space so the heading reads "## Starting with
another chatbot in Glific" (locate that exact heading text in docs/2. Pre
Onboarding/Adding a New Chatbot in Glific.md and trim the trailing whitespace).
|
|
||
| - **Important:** Do not install WhatsApp on this number.If using an existing number, uninstall WhatsApp from it before connecting to the bot. | ||
|
|
||
| ### Step 2: Filling the Glific onboarding form: |
Contributor
There was a problem hiding this comment.
Trailing colon and inconsistent heading style.
The heading ### Step 2: Filling the Glific onboarding form: has a trailing colon not present in Steps 1 and 3, and uses a gerund form ("Filling") inconsistent with the other step headings.
✏️ Proposed fix
-### Step 2: Filling the Glific onboarding form:
+### Step 2: Fill the Glific Onboarding Form📝 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
| ### Step 2: Filling the Glific onboarding form: | |
| ### Step 2: Fill the Glific Onboarding Form |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 24, The
heading "### Step 2: Filling the Glific onboarding form:" is inconsistent with
Steps 1 and 3 and has an unnecessary trailing colon; update this heading to
match the style of the others (use an imperative verb and remove the trailing
colon), e.g. change "### Step 2: Filling the Glific onboarding form:" to "###
Step 2: Fill the Glific onboarding form" so it aligns with the phrasing and
punctuation used in Step 1 and Step 3.
Comment on lines
+34
to
+41
| - Enter an app name (No space or special characters allowed). | ||
|
|
||
| This is something internal and not visible to your end users & also **it cannot be changed once setup is completed**. So you can go for something like `GlificChatbot` or `TamilNaduChatbot` etc… | ||
|
|
||
|  | ||
|
|
||
|
|
||
| - Once the App name is entered. It will show as **Created successfully**. Click on `Go to Dashboard`. |
Contributor
There was a problem hiding this comment.
Unindented continuation paragraph breaks the bullet list.
The prose on line 36 is not inside a list item, so it terminates the preceding list and starts a new one at line 41. Indent it (or prefix with -) to keep it logically attached to the app name entry step.
✏️ Proposed fix
- Enter an app name (No space or special characters allowed).
-This is something internal and not visible to your end users & also **it cannot be changed once setup is completed**. So you can go for something like `GlificChatbot` or `TamilNaduChatbot` etc…
+ This is something internal and not visible to your end users & also **it cannot be changed once setup is completed**. So you can go for something like `GlificChatbot` or `TamilNaduChatbot` etc…🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md around lines 34 -
41, The continuation prose following the bullet "Enter an app name (No space or
special characters allowed)." is not indented and breaks the list; fix it by
indenting that paragraph (or prefixing it with "- ") so the sentence starting
"This is something internal and not visible to your end users & also **it cannot
be changed once setup is completed**." remains part of the same list item; apply
the same indentation to the example app names line and the screenshot caption so
they stay under the "Enter an app name" bullet.
| - Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) | ||
|
|
||
|
|
||
| ### Connecting Gupshup to Glific: |
Contributor
There was a problem hiding this comment.
"Connecting Gupshup to Glific" is not numbered as Step 4.
Steps 1–3 use the ### Step N: … pattern, but this section breaks the convention with a plain heading. Number it for consistency.
✏️ Proposed fix
-### Connecting Gupshup to Glific:
+### Step 4: Connect Gupshup to Glific🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/Adding a New Chatbot in Glific.md at line 150, The
heading "Connecting Gupshup to Glific" breaks the established step-heading
convention; change it from an unnumbered "### Connecting Gupshup to Glific:" to
the numbered format used elsewhere (e.g., "### Step 4: Connecting Gupshup to
Glific:") so it follows the `### Step N: …` pattern used in Steps 1–3 and keeps
numbering consistent across the document.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added detailed instructions for onboarding a new chatbot in Glific, including steps for Gupshup app setup and connecting to Glific.
Summary by CodeRabbit