Skip to content

Conversation

@SangeetaMishr
Copy link
Collaborator

@SangeetaMishr SangeetaMishr commented Oct 15, 2025

added images and removed broken links

Summary by CodeRabbit

  • Documentation
    • Updated pre-onboarding guide with clearer, step-by-step instructions and embedded screenshots for enabling message events via webhooks and updating the display picture.
    • Replaced external link-based guidance with in-document walkthroughs, improving clarity and reducing context switching.
    • Reorganized steps to create a more intuitive navigation flow, including new images and captions.
    • Removed redundant sections to streamline the narrative while preserving the original objectives of webhook enablement and profile updates.

added images and removed broken links
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

Walkthrough

Updates 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

Cohort / File(s) Summary of changes
Docs: Gupshup setup steps and images
docs/2. Pre Onboarding/02. Gupshup Setup.md
Rewrote steps 26–27 to inline instructions for enabling all message events via Webhooks and updating the display picture; embedded new screenshots; removed standalone sections for read receipts and display picture; added updated references/links and revised captions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • Fawas003
  • mahajantejas

Poem

I hopped through docs with screenshot flair,
Rewrote the steps with careful care.
Webhooks on, display set right—
Click, confirm, a tidy sight.
Thump-thump goes my review drum—
Pre-onboarding made less glum. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title merely notes an update to a file by name without describing what was changed, such as added images or fixed links, and thus fails to convey the main changes in the PR. Consider revising the title to summarize the key modifications, for example “Add images and fix broken links in Gupshup setup guide,” so reviewers immediately understand the nature of the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Gupshup_Setup.md

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 github-actions bot temporarily deployed to pull request October 15, 2025 08:18 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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a9a830 and 364b9d7.

📒 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)

Comment on lines +185 to +192
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" />

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

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.

Suggested change
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)
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

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.

Suggested change
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.

@Fawas003 Fawas003 merged commit 2e208da into main Oct 17, 2025
7 checks passed
@akanshaaa19 akanshaaa19 deleted the Gupshup_Setup.md branch October 22, 2025 09:15
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.

3 participants