Skip to content

Conversation

@Fawas003
Copy link
Contributor

@Fawas003 Fawas003 commented Nov 4, 2025

Fixed broken links

Summary by CodeRabbit

  • Documentation
    • Updated event tracking documentation link and references to point to the Gupshup setup guide with specific step guidance for enabling event tracking.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2025

Walkthrough

This pull request updates a documentation file to change the event tracking setup reference from the Read Receipts guide to the Gupshup Setup guide, including updated link paths and references to the specific step number within that document.

Changes

Cohort / File(s) Summary
Documentation Link Update
docs/4. Product Features/03. Flows/4. Others/Message Events.md
Updates event tracking documentation link from Read Receipts doc to Gupshup Setup guide, changes step reference to "26th step", updates URL path, and removes extra line break

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single file with a straightforward documentation link and text update
  • No logic changes or complex structural modifications

Possibly related PRs

Suggested reviewers

  • mahajantejas

Poem

🐰 A link hopped from Receipts to Gupshup's new home,
Twenty-six steps to setup, no more docs to roam,
The Message Events guide now points the way true,
Through better documentation, we hop forward anew! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update Message Events.md' is vague and generic, using a non-descriptive term that doesn't convey the meaningful change of fixing broken documentation links. Consider using a more descriptive title such as 'Fix broken documentation link in Message Events.md' to clearly communicate the purpose of the change.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Message-Events.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 bot commented Nov 4, 2025

@github-actions github-actions bot temporarily deployed to pull request November 4, 2025 09:10 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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2bb52e and ae6bb3d.

📒 Files selected for processing (1)
  • docs/4. Product Features/03. Flows/4. Others/Message Events.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/4. Product Features/03. Flows/4. Others/Message Events.md

[style] ~14-~14: Consider using a different verb to strengthen your wording.
Context: ... For the tracking to be enabled, please make sure that you have activated tracking of the...

(MAKE_SURE_ENSURE)

🪛 markdownlint-cli2 (0.18.1)
docs/4. Product Features/03. Flows/4. Others/Message Events.md

14-14: Spaces inside link text

(MD039, no-space-in-links)

Comment on lines +14 to +15
For the tracking to be enabled, please make sure that you have activated tracking of these events in your gupshup app. Refer 26th step of [this documentation to configure the read receipts
](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup)
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 | 🔴 Critical

🧩 Analysis chain

Fix link text and grammar; verify link validity.

The link text and surrounding sentence have multiple issues:

  1. Misleading link text: The text "[this documentation to configure the read receipts" still references "read receipts," but the link now points to Gupshup Setup guide, which may not be about read receipts configuration.
  2. Grammar: "Refer 26th step of [...]" is awkward; should be "Refer to step 26 of [...]" or "Refer to the 26th step of [...]".
  3. Markdown formatting: The link text appears incomplete or improperly formatted based on the linting warning (MD039).

Please update the link text to accurately describe what the Gupshup Setup guide covers (event tracking setup vs. read receipts configuration), improve the grammar, and ensure the referenced "26th step" is the correct location for event tracking configuration.

Suggested fix (pending your verification of content accuracy):

- For the tracking to be enabled, please make sure that you have activated tracking of these events in your gupshup app. Refer 26th step of [this documentation to configure the read receipts
- ](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup)
+ For the tracking to be enabled, please ensure that you have activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup Setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for configuration details.

Please verify:

  1. That the link URL is correct and resolves to the intended Gupshup Setup documentation
  2. That step 26 is indeed the correct reference for event tracking configuration
  3. That the updated link text accurately describes what users will find at that destination


---

🏁 Script executed:

```shell
#!/bin/bash
# Find and examine the target documentation file
find . -type f -name "Message Events.md" 2>/dev/null | head -20

Length of output: 64


🏁 Script executed:

#!/bin/bash
# Check the actual content around lines 14-15 of the file
if [ -f "docs/4. Product Features/03. Flows/4. Others/Message Events.md" ]; then
  echo "=== File content (lines 10-20) ==="
  sed -n '10,20p' "docs/4. Product Features/03. Flows/4. Others/Message Events.md"
  echo ""
  echo "=== Full file for context ==="
  cat "docs/4. Product Features/03. Flows/4. Others/Message Events.md"
fi

Length of output: 3604


🏁 Script executed:

#!/bin/bash
# Search for references to Gupshup Setup or event tracking in docs
rg -n "Gupshup Setup|event tracking" docs/ --type md -C 2

Length of output: 863


🏁 Script executed:

#!/bin/bash
# Check repo structure and type
if [ -f "README.md" ]; then
  head -50 README.md
fi

Length of output: 769


Fix misleading link text, grammar, and markdown formatting.

The link and surrounding text have three confirmed issues:

  1. Misleading link text: References "configure the read receipts" but links to the general Gupshup Setup guide (read receipts is only one of several tracked message events). Update link text to reflect actual destination.
  2. Grammar: "Refer 26th step of [...]" is awkward; change to "Refer to step 26 of [...]" or "Refer to the 26th step of [...]".
  3. Markdown formatting: Link text spans lines 14-15; keep entire link on a single line.

Update lines 14-15 to:

For the tracking to be enabled, please ensure that you have activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup Setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for configuration details.

Verify that step 26 in the Gupshup Setup guide indeed covers event tracking configuration before applying.

🧰 Tools
🪛 LanguageTool

[style] ~14-~14: Consider using a different verb to strengthen your wording.
Context: ... For the tracking to be enabled, please make sure that you have activated tracking of the...

(MAKE_SURE_ENSURE)

🪛 markdownlint-cli2 (0.18.1)

14-14: Spaces inside link text

(MD039, no-space-in-links)

🤖 Prompt for AI Agents
In docs/4. Product Features/03. Flows/4. Others/Message Events.md around lines
14-15, the sentence and link are misleading and poorly formatted; replace the
text to correct grammar, make the link text reflect the actual destination (the
Gupshup Setup guide), and keep the Markdown link on a single line — e.g., change
to a sentence like "For the tracking to be enabled, please ensure that you have
activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup
Setup
guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for
configuration details." — also verify that step 26 actually covers event
tracking before committing.

@SangeetaMishr SangeetaMishr merged commit bc96bfd into main Nov 4, 2025
7 checks passed
@SangeetaMishr SangeetaMishr deleted the Message-Events.md branch November 4, 2025 09:24
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