-
Notifications
You must be signed in to change notification settings - Fork 9
Update 02. Gupshup Setup.md #454
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
added images and removed broken links
WalkthroughUpdates the Gupshup onboarding documentation to replace link-based instructions with inline, step-by-step guidance and embedded screenshots for enabling message event webhooks and updating the display picture. Removes separate detailed sections, consolidating them into the numbered flow with new images and references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
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-454--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: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Pre Onboarding/02. Gupshup Setup.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2. Pre Onboarding/02. Gupshup Setup.md
[grammar] ~185-~185: There might be a mistake here.
Context: ...iew arrow` beside the app name(as shown in 1st screenshot), go to Webhooks and Ena...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.18.1)
docs/2. Pre Onboarding/02. Gupshup Setup.md
195-195: Spaces inside link text
(MD039, no-space-in-links)
| 26. On the app name click on the `overview arrow` beside the app name(as shown in 1st screenshot), go to Webhooks and Enable all the message events (as shown in the below second screenshot). | ||
|
|
||
| 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/) | ||
| <img width="1050" alt="image" src="https://github.com/user-attachments/assets/cb70dbb3-12e8-4ad8-9b9b-e09dee793ab8" /> | ||
|
|
||
|
|
||
|
|
||
| <img width="692" height="463" alt="image" src="https://github.com/user-attachments/assets/d5dd0207-d48f-42dd-ade6-7593f4f514cf" /> | ||
|
|
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.
Clarify Step 26 wording and spacing.
The sentence is hard to parse ("app name(as...") and repeats phrases. Please rephrase with proper spacing for clarity.
-26. On the app name click on the `overview arrow` beside the app name(as shown in the below second screenshot), go to Webhooks and Enable all the message events (as shown in the below second screenshot).
+26. Click the overview arrow beside your app name (as shown in the first screenshot), open **Webhooks**, and enable all message events (as shown in the second screenshot below).📝 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.
| 26. On the app name click on the `overview arrow` beside the app name(as shown in 1st screenshot), go to Webhooks and Enable all the message events (as shown in the below second screenshot). | |
| 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/) | |
| <img width="1050" alt="image" src="https://github.com/user-attachments/assets/cb70dbb3-12e8-4ad8-9b9b-e09dee793ab8" /> | |
| <img width="692" height="463" alt="image" src="https://github.com/user-attachments/assets/d5dd0207-d48f-42dd-ade6-7593f4f514cf" /> | |
| 26. Click the overview arrow beside your app name (as shown in the first screenshot), open **Webhooks**, and enable all message events (as shown in the second screenshot below). | |
| <img width="1050" alt="image" src="https://github.com/user-attachments/assets/cb70dbb3-12e8-4ad8-9b9b-e09dee793ab8" /> | |
| <img width="692" height="463" alt="image" src="https://github.com/user-attachments/assets/d5dd0207-d48f-42dd-ade6-7593f4f514cf" /> |
🧰 Tools
🪛 LanguageTool
[grammar] ~185-~185: There might be a mistake here.
Context: ...iew arrow` beside the app name(as shown in 1st screenshot), go to Webhooks and Ena...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In docs/2. Pre Onboarding/02. Gupshup Setup.md around lines 185 to 192, Step
26's sentence is cramped and repetitive ("app name(as..." and duplicated "as
shown"); rephrase it into one or two clear sentences with proper spacing and
punctuation, e.g. state that the user should click the overview arrow beside the
app name, navigate to Webhooks, and enable all message events; remove the
duplicate "as shown" and ensure screenshots are referenced once with a short
caption.
|
|
||
|
|
||
|
|
||
| 27. Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) |
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.
Remove the extra space inside the link text.
markdownlint (MD039) flags the trailing space before the closing bracket.
-27. Please refer to [add display picture ](https://docs.gupshup.io/docs/profile)
+27. 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.
| 27. Please refer to [add display picture ](https://docs.gupshup.io/docs/profile) | |
| 27. Please refer to [add display picture](https://docs.gupshup.io/docs/profile) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
195-195: Spaces inside link text
(MD039, no-space-in-links)
🤖 Prompt for AI Agents
In docs/2. Pre Onboarding/02. Gupshup Setup.md around line 195, the markdown
link text contains an extra trailing space before the closing bracket ("add
display picture "); remove that trailing space so the link text reads "add
display picture" to satisfy markdownlint MD039; update the line to use the
corrected link text while keeping the same URL.
added images and removed broken links
Summary by CodeRabbit