Update 01. Glific Overview.md #469
Conversation
Broken Links fixed for 'Glific Oberview' Page
WalkthroughDocumentation updates to redirect references from onboarding toolkit paths to Pre Onboarding documentation paths, including GCS setup, Facebook Business Manager verification, Gupshup setup, and general support documentation links. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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-469--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| e. **Setup Google CloudConsole (GCS)** | ||
|
|
||
| The assigned POC from your organization will be expected to follow this process independently, using our [comprehensive documentation](https://glific.github.io/docs/docs/Onboarding/Glific%20Onboarding%20Toolkit), which includes detailed steps with images and videos. | ||
| The assigned POC from your organization will be expected to follow this process independently, using our [comprehensive documentation](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS), which includes detailed steps with images and videos. |
There was a problem hiding this comment.
🧩 Analysis chain
Verify that link paths are consistent across all updated documentation links.
Line 70 updates the GCS setup link to use a Pre Onboarding documentation path with URL-encoded spaces (%20). Ensure this link format is consistent with the other documentation links updated on lines 85 and 144-146.
🏁 Script executed:
#!/bin/bash
# Description: Verify URL formatting consistency across all updated documentation links
# Extract all glific.github.io documentation links from the file
rg -n 'glific\.github\.io' docs/01.\ Glific\ Overview.md | head -20Length of output: 713
Add trailing slash to line 70 URL for consistency with other documentation links.
Line 70 is missing a trailing slash: https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS. Lines 144-145 include trailing slashes for similar paths (...Gupshup%20Setup/, ...Business%20API/). Update line 70 to end with GCS/ for consistency across all documentation links.
🤖 Prompt for AI Agents
In docs/01. Glific Overview.md around line 70, the GCS documentation URL is
missing a trailing slash; update the link to end with
"Google%20Cloud%20Storage%20Setup%20-%20GCS/" (add the trailing slash) so it
matches the trailing-slash pattern used on lines 144-145 and keeps link
formatting consistent across the docs.
| - [Get Facebook Business Manager Verified](https://glific.github.io/docs/docs/Pre%20Onboarding/Facebook%20Verification%20Process%20for%20WhatsApp%20Business%20API/) for your organisation | ||
| - [Setup on Gupshup](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup/) | ||
| - [Submit your details here](https://prod.glific.com/organization-registration) |
There was a problem hiding this comment.
🧩 Analysis chain
Ensure consistency in trailing slashes across documentation links.
The "Next Steps" links on lines 144-145 include trailing slashes and use Pre%20Onboarding/ path structure, while line 70's GCS link omits the trailing slash. Verify whether this difference is intentional (e.g., directory vs. file paths) or if all documentation links should follow a consistent format.
🏁 Script executed:
#!/bin/bash
# Description: Audit URL formatting consistency
# Show all documentation link patterns
echo "=== Updated documentation links ==="
rg -n 'glific\.github\.io.*docs' docs/01.\ Glific\ Overview.md
echo ""
echo "=== Link trailing slash analysis ==="
rg -n 'glific\.github\.io.*docs' docs/01.\ Glific\ Overview.md | \
awk -F'https' '{print $2}' | \
sed 's/^/https/' | \
while read link; do
if [[ $link == */ ]]; then
echo "✓ WITH trailing slash: ${link:0:80}..."
else
echo "✗ WITHOUT trailing slash: ${link:0:80}..."
fi
doneLength of output: 1216
Add trailing slash to line 70 GCS documentation link for consistency.
The GCS Setup link on line 70 (https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS) lacks a trailing slash, while the similar documentation links on lines 144–145 include them. Consistency in trailing slash usage is a clear best practice, especially since it's more conventional to use a trailing slash with directory URLs. Update line 70 to end with a trailing slash: ...GCS/
🤖 Prompt for AI Agents
In docs/01. Glific Overview.md around lines 144-146, the reviewer notes an
inconsistency: the GCS Setup link earlier (line 70) lacks a trailing slash while
other documentation links include one; update the GCS URL on line 70 to append a
trailing slash (change ...Google%20Cloud%20Storage%20Setup%20-%20GCS to
...Google%20Cloud%20Storage%20Setup%20-%20GCS/) so all doc links use a
consistent trailing-slash format.
Broken Links fixed for 'Glific Oberview' Page.
Summary by CodeRabbit