Skip to content

Update 01. Glific Overview.md #469

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 17, 2025
Merged

Update 01. Glific Overview.md #469

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/01. Glific Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ d. **Complete the [Glific Onboarding Form](https://prod.glific.com/organization-

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.
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 17, 2025

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

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 -20

Length 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.

Our team will support you if you get stuck at any of these steps through call/Discord/email.

### Training and Support Post-Onboarding
Expand All @@ -82,7 +82,7 @@ A detailed plan for these sessions will be shared during the onboarding process.

**Support channels available with Glific:** As a SaaS platform, we provide ongoing support if you have a question/issues on platform-

1. **Documentation** – Our [documentation](https://glific.github.io/docs/docs/intro/) usually will have 90% of the answers to your questions.
1. **Documentation** – Our [documentation](https://glific.github.io/docs/docs/) usually will have 90% of the answers to your questions.

2. **Query resolution:** You can raise a query through our [Discord channel](https://discord.gg/gYHMRGQVpT), where our AI bot will provide an instant response. If needed, our team will follow up based on the type of request.

Expand Down Expand Up @@ -141,9 +141,9 @@ These additional pointers may help you with the planning and piloting. The pilot

# Next Steps

- [Get Facebook Business Manager Verified](https://glific.github.io/docs/docs/Onboarding/Facebook%20Verification%20Process%20for%20WhatsApp%20Business%20API) for your organisation
- [Setup on Gupshup](https://glific.github.io/docs/docs/Onboarding/Setup%20an%20organisation%20on%20GupShup/)
- [Submit your details here](https://glific.github.io/docs/docs/Onboarding/Onboarding%20Form%20Fill%20Up)
- [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)
Comment on lines +144 to +146
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 17, 2025

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

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
  done

Length 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.


Note : When your Glific instance is set up, it is recommended that you provide us support access to your account. We generally name that support contact "SaaS Admin". If this contact does not exist it might be harder for us to provide you the ideal turnaround on support issues.

Expand Down