Add Gupshup connection instructions to Glific#575
Conversation
Added instructions for connecting Gupshup to Glific, including steps for logging in, entering app details, and saving the configuration.
📝 WalkthroughWalkthroughThis PR adds a new "Connecting Gupshup to Glific" section to the Gupshup setup documentation. The addition includes step-by-step instructions with UI interactions and images for configuring Gupshup integration, expanding the onboarding guide with actionable setup procedures. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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-575--glific-docs.netlify.app |
![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)
227-227: Format as a proper subheading for document structure consistency.The text "Update Details in Glific" appears to be a subsection header but uses bold formatting instead of a proper heading (e.g.,
####). For consistency with the rest of the document structure and to improve navigation, consider formatting it as a level 4 heading.📝 Proposed fix for consistent heading structure
-**Update Details in Glific** +#### Update Details in Glific🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md at line 227, Replace the bolded line "**Update Details in Glific**" with a proper level-4 Markdown heading (e.g., "#### Update Details in Glific") so it matches the document's heading structure and improves navigation; locate the exact text "Update Details in Glific" to update it.
218-225: Add a screenshot showing the API Key location in Gupshup.The current instructions mention copying the API Key from app settings (line 225), but the image at line 222 only shows the overview arrow (reused from earlier sections) and doesn't display where the API Key is actually located. Adding a dedicated screenshot showing the Settings page with the API Key field highlighted would significantly improve user experience and reduce setup friction.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md around lines 218 - 225, Replace the current generic image under the "Gupshup Setup" section with a new screenshot that clearly shows the App Settings page where the API Key is displayed; specifically capture and highlight the API Key field referenced by the line "Copy your API Key from the app settings.", include a visible highlight/annotation (arrow or box), update the image alt text to describe "Gupshup API Key location", and ensure any real API key is redacted or replaced with a placeholder before committing.
🤖 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/02. Gupshup Setup.md:
- Around line 225-226: The instruction "Copy your API Key from the app
settings." is too vague; replace it with explicit navigation steps that tell
users exactly where to find the API Key in Gupshup. Update the line containing
that sentence to read something like: "In the Gupshup dashboard click the
overview arrow beside your app name → select Settings → scroll to 'API Key'
(under Credentials) and click the copy icon to copy your API Key." Also add an
accompanying screenshot with the 'API Key' field highlighted and a short caption
so users can visually confirm they are in the right place.
---
Nitpick comments:
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md:
- Line 227: Replace the bolded line "**Update Details in Glific**" with a proper
level-4 Markdown heading (e.g., "#### Update Details in Glific") so it matches
the document's heading structure and improves navigation; locate the exact text
"Update Details in Glific" to update it.
- Around line 218-225: Replace the current generic image under the "Gupshup
Setup" section with a new screenshot that clearly shows the App Settings page
where the API Key is displayed; specifically capture and highlight the API Key
field referenced by the line "Copy your API Key from the app settings.", include
a visible highlight/annotation (arrow or box), update the image alt text to
describe "Gupshup API Key location", and ensure any real API key is redacted or
replaced with a placeholder before committing.
| - Copy your API Key from the app settings. | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
rg -n -C3 "API Key" "docs/2. Pre Onboarding/02. Gupshup Setup.md"Repository: glific/docs
Length of output: 460
🏁 Script executed:
# Check file size and read the relevant section
wc -l "docs/2. Pre Onboarding/02. Gupshup Setup.md"Repository: glific/docs
Length of output: 102
🏁 Script executed:
# Read the section in question (lines 210-250)
sed -n '210,250p' "docs/2. Pre Onboarding/02. Gupshup Setup.md" | cat -nRepository: glific/docs
Length of output: 1636
🏁 Script executed:
# Also check if there are images or references that might clarify API Key location
rg -n "image|Image|png|jpg|settings|Settings" "docs/2. Pre Onboarding/02. Gupshup Setup.md" | grep -i -E "(220|221|222|223|224|225|226|227|228)" | head -20Repository: glific/docs
Length of output: 1154
Add specific navigation steps to locate the API Key in Gupshup.
The instruction at line 225 "Copy your API Key from the app settings" lacks specific navigation details. Users may struggle to find where the API Key is located within Gupshup's interface. Add step-by-step instructions such as: "Click on the overview arrow beside the app name → Navigate to Settings → Locate and copy the API Key" and include a screenshot that clearly highlights the API Key field to make the process unambiguous.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md around lines 225 - 226, The
instruction "Copy your API Key from the app settings." is too vague; replace it
with explicit navigation steps that tell users exactly where to find the API Key
in Gupshup. Update the line containing that sentence to read something like: "In
the Gupshup dashboard click the overview arrow beside your app name → select
Settings → scroll to 'API Key' (under Credentials) and click the copy icon to
copy your API Key." Also add an accompanying screenshot with the 'API Key' field
highlighted and a short caption so users can visually confirm they are in the
right place.
1 participant
Added instructions for connecting Gupshup to Glific, including steps for logging in, entering app details, and saving the configuration.
Summary by CodeRabbit