Refactor Glific Overview documentation for clarity and consistency #403
Conversation
WalkthroughThe PR adds front matter and restructures Changes
Sequence Diagram(s)sequenceDiagram
actor NGO as NGO Team
participant Docs as Glific Docs
participant FBM as Facebook Business Manager
participant Gup as Gupshup
participant GCP as Google Cloud Console
participant Support as Glific Support
NGO->>Docs: Read Glific Overview (onboarding, pricing, references)
Docs-->>NGO: Display onboarding sequence & checklists
rect rgb(240,248,255)
note over NGO,Support: Detailed onboarding flow
NGO->>Support: Join Discord / request Tuesday support call
NGO->>Gup: Acquire WhatsApp number & configure provider
NGO->>FBM: Verify Business Manager
NGO->>Docs: Complete onboarding form
NGO->>GCP: Set up project/credentials
end
Docs-->>NGO: Pricing table, setup timelines, reference articles
Support-->>NGO: Ongoing assistance / consulting option
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (20)
docs/01. Glific Overview.md (20)
1-5: Confirm homepage intent for slug "/"Setting
slug: /makes this page the docs site homepage. If that’s intentional, great; if not, set a unique slug (e.g.,/glific-overview) and manage landing via navbar/sidebar.Apply this diff only if you don’t want it as the homepage:
-slug: / +slug: /glific-overview
7-7: Remove manual “4 minute read / Beginner” bannerDocusaurus can compute reading time; the current line uses a long run of non‑breaking spaces, hurts a11y, and is brittle.
Apply:
-> ### **4 minute read `Beginner`**
21-25: Tighten grammar and add timezone for support hourMinor readability fixes and clarify timezone for weekly calls.
Apply:
-Glific is a SaaS platform that enables NGOs to build and manage their own WhatsApp chatbot. -Glific is easy to use and can be set up in an easier manner with our detailed documentation. -We recommend having at least one dedicated team member to take ownership of the chatbot for a long term. -Our support team is available via an active Discord channel for queries related to the platform, features, or bugs, and we also host weekly support hour calls every Tuesday for all NGOs. +Glific is a SaaS platform that enables NGOs to build and manage their own WhatsApp chatbot. +Glific is easy to use and can be set up easily with our detailed documentation. +We recommend having at least one dedicated team member to take ownership of the chatbot for the long term. +Our support team is available via an active Discord channel for queries related to the platform, features, or bugs. We also host weekly support-hour calls every Tuesday from 3:30 PM to 4:00 PM IST (UTC+05:30) for all NGOs.
34-40: Polish “Before you get started” itemsClarify phrasing, currency, and fix “usecase” spelling.
Apply:
-1. **A Facebook page and an active phone number which is not on WhatsApp to set up the chatbot.** +1. **A Facebook page and an active phone number that is not on WhatsApp to set up the chatbot.** -2. **Funds to run the chatbot**- On an average an NGO spends between 10-15k per month if they are using the chatbot to run reminder messages to 500 people once a week. +2. **Funds to run the chatbot** – On average, an NGO spends INR 10k–15k per month when sending reminder messages to ~500 people once a week. -3. **Clarity on the program** to run the WhatsApp chatbot on: For example- Build a teacher training chatbot to train teachers on basic computer literacy skills twice a week in a month or send reminders to target users to eat healthy meals once a week for a period of six months. - [Here’s](https://docs.google.com/document/d/1jQcSOLfASa_RR7f_JlZd7WT2INaSC9tTQCNdWI_EOOw/edit?tab=t.0) a reference use case document for you to start documenting your usecase. +3. **Clarity on the program** the WhatsApp chatbot will support. For example: build a teacher‑training chatbot to deliver basic computer‑literacy content twice a week for a month; or send weekly reminders encouraging healthy eating for six months. + [Here’s](https://docs.google.com/document/d/1jQcSOLfASa_RR7f_JlZd7WT2INaSC9tTQCNdWI_EOOw/edit?tab=t.0) a reference use‑case document to help you start documenting your use case.Please confirm the monthly cost estimate and audience size are still representative; if not, consider framing them as examples with a date stamp.
41-47: Subject–verb agreement and clarity in team skillsMinor grammar and clarity adjustments.
Apply:
-4. **A long-term dedicated team member to anchor the chatbot for you**. Please find the key skills required in the team member below: +4. **A long‑term, dedicated team member to anchor the chatbot.** Key skills: - a) **Program knowledge** - The person responsible should know the program well and has a fair understanding of how conversation works with the - target users. Ensure chatbot aligns with the program’s on-ground operations and objectives. + a) **Program knowledge** – The person should know the program well and have a solid understanding of how conversations work with target users. Ensure the chatbot aligns with on‑ground operations and objectives. - b) **Basic tech & logic reasoning skills** - Setting up flows would require some logical reasoning, data and problem-solving skills. + b) **Basic tech and logical‑reasoning skills** – Setting up flows requires logical reasoning, comfort with data, and problem‑solving skills.
66-71: Fix “Setup” vs “Set up” and product namesUse “Set up” (verb), and correct “Google Cloud Console” acronym to avoid clashing with “GCS” (which commonly means Cloud Storage).
Apply:
-d. **Complete the [Glific Onboarding Form](https://prod.glific.com/organization-registration)** +d. **Complete the [Glific Onboarding Form](https://prod.glific.com/organization-registration)** -e. **Setup Google CloudConsole (GCS)** +e. **Set up Google Cloud Console (GCP)**If you intended “Google Cloud Storage,” explicitly say “Google Cloud Storage (GCS)” and describe what needs to be set up (e.g., bucket, service account).
77-81: Parallelism and punctuation in training bulletsUse consistent style and fix ampersand phrasing.
Apply:
-- Hands-on training on the Glific platform -- Best practices & introducing a few more features -- Data and dashboard overview +- Hands‑on training on the Glific platform +- Best practices and selected advanced features +- Data and dashboard overview
85-93: Support channels: link spacing, timezone, and clarityMinor formatting and timezone addition; ensures readability.
Apply:
-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/intro/) typically has answers to most 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. +2. **Query resolution:** Raise a query on our [Discord channel](https://discord.gg/gYHMRGQVpT). Our AI bot responds instantly; the team follows up as needed. -3. **Support Hour Calls:** For facetime with our support team to get your queries resolved, you can join weekly support hour [group call](https://meet.google.com/ced-hbmr-suh) held on Tuesdays from 3:30 PM to 4:00 PM +3. **Support‑hour calls:** Join the weekly [group call](https://meet.google.com/ced-hbmr-suh) every Tuesday, 3:30–4:00 PM IST (UTC+05:30). -4. **Level Up Webinars:** We conduct an advanced webinar at the end of every month, where we share about new Glific features, encourage cross learning and also conduct sessions which will be helpful for your chatbot programs. - Topics and dates for this webinar will be communicated in advance via Email, [Monthly Newsletter](https://zcmp.in/E4S7),[Discord channel](https://discord.gg/gYHMRGQVpT), & [Glific Community WhatsApp Groups](https://chat.whatsapp.com/KxUanZQ8EKW81SO4x4pmKO). +4. **Level Up webinars:** We host an advanced webinar at the end of every month to share new Glific features, encourage cross‑learning, and run sessions helpful for chatbot programs. + Topics and dates are shared in advance via email, our [monthly newsletter](https://zcmp.in/E4S7), [Discord](https://discord.gg/gYHMRGQVpT), and [Glific Community WhatsApp Groups](https://chat.whatsapp.com/KxUanZQ8EKW81SO4x4pmKO).Consider replacing ephemeral invite links with a stable redirect (e.g., glific.org/discord) to reduce link rot.
100-108: Pricing table grammar and accuracy caveatFix minor grammar and ask to reconfirm Meta pricing table values/category names periodically (they change over time).
Apply:
-1. A one-time onboarding fee of INR 15,000 + taxes covers account setup, onboarding assistance, and platform training. +1. A one‑time onboarding fee of INR 15,000 + taxes covers account setup, onboarding assistance, and platform training. 2. A platform fee of INR 9,500/month + taxes. -3. WhatsApp messaging fees are charged, based on user-initiated (UI) and business-initiated (BI) conversations. Refer to the table below for - detailed pricing: +3. WhatsApp messaging fees are charged based on user‑initiated (UI) and business‑initiated (BI) conversations. Refer to the table below for detailed pricing: -| Market | Currency | Marketing | Utility | Authentication | Service | -| ----------------------------------------------------------------------------------------------------- | -------- | --------- | ------- | -------------- | ------- | -| India, For other regions,refer to this [link](https://developers.facebook.com/docs/whatsapp/pricing/) | USD | 0.0107 | 0.0014 | 0.0014 | Free | +| Market | Currency | Marketing | Utility | Authentication | Service | +| ---------------------------------------------------------------------------------------------------- | -------- | --------- | ------- | -------------- | ------- | +| India. For other regions, refer to this [link](https://developers.facebook.com/docs/whatsapp/pricing/) | USD | 0.0107 | 0.0014 | 0.0014 | Free |Action: Please verify these per Meta’s latest pricing as of August 2025 and add a “Last verified: YYYY‑MM‑DD” note below the table.
109-111: Grammar: surcharge paragraphAdd a comma and tighten phrasing.
Apply:
-Gupshup charges a surcharge of 0.001 USD per message (Incoming & Outgoing) until you reach a volume of 75k messages in a month. -Beyond that it charges a flat rate of $75 for a month. +Gupshup charges a surcharge of USD 0.001 per message (incoming and outgoing) until you reach 75k messages in a month. +Beyond that, it charges a flat rate of USD 75 per month.Please confirm these Gupshup rates and thresholds; consider linking to Gupshup’s pricing page and adding “Last verified” note.
112-112: BigQuery free-tier note may change; add verification dateCloud free tiers evolve. Suggest adding “Last verified” date and link to official pricing.
Apply:
-4. **Google Cloud Storage and BigQuery fees:** Google BigQuery, used for storing and accessing chatbot data, provides new Google Cloud users with $300 in free credits valid for 90 days. The free tier is often sufficient for initial needs, covering up to 10GB of storage and 1TB of queries per month. You’ll only incur charges if your usage exceeds these free limits. For more details, see [Google’s pricing page](https://cloud.google.com/bigquery/pricing). +4. **Google Cloud Storage and BigQuery fees:** Google BigQuery provides new Google Cloud users with USD 300 in free credits (valid for 90 days). The free tier often covers initial needs (historically up to 10 GB storage and 1 TB queries per month). Charges apply if usage exceeds free limits. For details, see [Google’s pricing page](https://cloud.google.com/bigquery/pricing). Last verified: YYYY‑MM‑DD.
116-121: Defining your use case: tighten languageImprove readability; remove “etc…” filler.
Apply:
-1. **Your use case and how you plan to use it. For what programs, the scale, etc…** - (The reason is that once the NGOs identified the process and have documented how communications will happen at their organisations, it will be easier to apply Glific or any relevant software solution for that. Identifying and refining the process is key and super important.) +1. **Your use case and scope.** Which programs, expected scale, and success metrics. + (Once NGOs identify and document their communication processes, it becomes easier to apply Glific or any relevant software solution. Identifying and refining the process is key.)
121-126: List numbering and grammarContinue numbering and fix grammar/structure.
Apply:
-2. **Your proposed workflow:** [**Example 1**](https://docs.google.com/document/d/1jQcSOLfASa_RR7f_JlZd7WT2INaSC9tTQCNdWI_EOOw/edit)**,** [**Example 2**](https://docs.google.com/document/d/1WxIWityZm3rEuQKM5m2U81gA7EhNgKrj/edit) - -(This a sample flow for ideas, your proposed workflow should be different from the example.) - -1. **Details and description of any previous pilot experiments(with 10-50 users)** - (Your NGO has done using your personal WhatsApp account. This gives you a better idea of how you might want to structure the interaction, to begin with.) -1. [Knowledge of WhatsApp Ecosystem](https://glific.org/7-things-you-must-know-about-using-whatsapp-chatbot/) +2. **Your proposed workflow:** [Example 1](https://docs.google.com/document/d/1jQcSOLfASa_RR7f_JlZd7WT2INaSC9tTQCNdWI_EOOw/edit), [Example 2](https://docs.google.com/document/d/1WxIWityZm3rEuQKM5m2U81gA7EhNgKrj/edit) + + (These are examples for inspiration; your workflow should be tailored to your context.) + +3. **Details and description of any previous pilot experiments (10–50 users)** + (If you’ve piloted using a personal WhatsApp account, note what worked and what didn’t; this will inform initial structure.) +4. **[Knowledge of the WhatsApp ecosystem](https://glific.org/7-things-you-must-know-about-using-whatsapp-chatbot/)**Ensure the linked Google Docs are world-readable (view only) to avoid access errors.
144-147: Consistency: organisation vs organization; “Set up” vs “Setup”Align spelling and verb form.
Apply:
-- [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/Onboarding/Facebook%20Verification%20Process%20for%20WhatsApp%20Business%20API) for your organization +- [Set up 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)If British spelling is the house style, switch all “organization” variants to “organisation” consistently across the doc instead.
152-161: Rename Data Studio to Looker Studio; capitalize FB; minor clarityGoogle Data Studio was rebranded to Looker Studio. Also fix “fb” to “FB”.
Apply:
-| Program design | 3-4 days | _(depends on the NGO speed) (can be done in parallel during fb and Gupshup process_) | -| Get Facebook business manager verified | 5-20 days | _(5 days if all paperwork like branding, address proofs are in order, 20 days or more if it’s not)_ | +| Program design | 3–4 days | _(depends on the NGO’s speed; can be done in parallel during FB and Gupshup process)_ | +| Get Facebook Business Manager verified | 5–20 days | _(≈5 days if branding/address proofs are in order; 20+ days if not)_ | | Setup Glific | 1 day | | -| GCS, BQ, DataStudio account creation and linking to Glific | 1 day | _(can be done in parallel during fb and Gupshup process)_ | -| Setup flows on Glific | 6-8 days | _(depends on the complexity and volume of flow and messages)_ | -| Test internally and with a ~20 end users | 3-4 days | _(test the flow plans before making it live for larger audience)_ | +| GCS, BQ, Looker Studio account creation and linking to Glific | 1 day | _(can be done in parallel during FB and Gupshup process)_ | +| Set up flows on Glific | 6–8 days | _(depends on the complexity and volume of flows and messages)_ | +| Test internally and with ~20 end users | 3–4 days | _(test the flow plans before going live to a larger audience)_ |
174-180: Fix typos and capitalization in Billing OptionsCorrect “Pre-biled”, ensure consistent capitalization and hyphenation.
Apply:
-1. **Billing Options:** +1. **Billing options** -- **Monthly:** Payment via credit card or bank transfer. Pre-biled for the month. -- **Quarterly:** Payment via cheque, NEFT or Bank transfers. Pre-billed for the quarter. -- **Annually:** Payment via cheque, NEFT or Bank transfers. Pre-billed for the year. +- **Monthly:** Payment via credit card or bank transfer. Pre‑billed for the month. +- **Quarterly:** Payment via cheque, NEFT, or bank transfer(s). Pre‑billed for the quarter. +- **Annually:** Payment via cheque, NEFT, or bank transfer(s). Pre‑billed for the year.
182-185: Subscription always-on: consider adding opt‑out pathwayPolicy statement is clear; add how to pause/opt out (email/contact form) and required notice.
I can draft a one‑liner with the official support email/URL if you share it.
186-190: Suspension policy: streamline phrasing and confirm maintenance feeMinor copyedits and clarity on maintenance fee; confirm amount and taxes.
Apply:
-If your organization is undergoing a strategizing phase, pausing operations, or has completed the program for which the WhatsApp chatbot was implemented, you can choose to temporarily suspend your account. Please notify us at least one month in advance. During suspension, access to the platform will be restricted, and the chatbot will not send or receive messages. -A subscription fee of INR 1500 per month + taxes will apply for the account maintenance. +If your organization is strategizing, pausing operations, or has completed the relevant program, you may suspend your account. Please notify us at least one month in advance. During suspension, access to the platform is restricted and the chatbot will not send or receive messages. +A maintenance fee of INR 1,500 per month + taxes applies during suspension.Action: Please confirm INR 1,500 + taxes is the current amount as of August 2025 and add “Effective from: YYYY‑MM‑DD.”
127-172: Trailing colons in headings (markdownlint MD026)Some headings end with a colon (e.g., “Important Points:”); recommended to drop trailing punctuation for consistency and lints.
If you follow markdownlint, remove trailing “:” in headings like “Important Points:” and “About Glific and how it works:” for consistency.
98-112: Add “as of” date to pricing sectionsPricing (Meta WhatsApp, Gupshup, platform) changes over time. Add an “as of” date to reduce future ambiguity.
I can add a small “Note: Pricing verified as of YYYY‑MM‑DD” block under each pricing subsection if you share the verification date.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/01. Glific Overview.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/01. Glific Overview.md
[grammar] ~23-~23: There might be a mistake here.
Context: ...wnership of the chatbot for a long term. Our support team is available via an act...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ... once a week for a period of six months. [Here’s](https://docs.google.com/docu...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...rsation works with the target users. Ensure chatbot aligns with the program’s on-gr...
(QB_NEW_EN)
[grammar] ~77-~77: There might be a mistake here.
Context: ...Hands-on training on the Glific platform - Best practices & introducing a few more ...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...ctices & introducing a few more features - Data and dashboard overview A detailed ...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...g | Utility | Authentication | Service | | --------------------------------------...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...- | ------- | -------------- | ------- | | India, For other regions,refer to this...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...ach a volume of 75k messages in a month. Beyond that it charges a flat rate of $7...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...eds, covering up to 10GB of storage and 1TB of queries per month. You’ll only incur...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...it. For what programs, the scale, etc…** (The reason is that once the NGOs identi...
(QB_NEW_EN)
[uncategorized] ~117-~117: Do not mix variants of the same word (‘organisation’ and ‘organization’) within a single text.
Context: ...how communications will happen at their organisations, it will be easier to apply Glific or a...
(EN_WORD_COHERENCY)
[grammar] ~123-~123: There might be a mistake here.
Context: ...us pilot experiments(with 10-50 users)** (Your NGO has done using your personal W...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...ructure the interaction, to begin with.) 1. [Knowledge of WhatsApp Ecosystem](https:/...
(QB_NEW_EN)
[grammar] ~176-~176: Ensure spelling is correct
Context: ...t via credit card or bank transfer. Pre-biled for the month. - Quarterly: Payment...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~176-~176: There might be a mistake here.
Context: ... bank transfer. Pre-biled for the month. - Quarterly: Payment via cheque, NEFT or...
(QB_NEW_EN)
[grammar] ~177-~177: Ensure spelling is correct
Context: ...the month. - Quarterly: Payment via cheque, NEFT or Bank transfers. Pre-billed for...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~178-~178: Ensure spelling is correct
Context: ...he quarter. - Annually: Payment via cheque, NEFT or Bank transfers. Pre-billed for...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~188-~188: Try moving the adverb to make the sentence clearer.
Context: ...atsApp chatbot was implemented, you can choose to temporarily suspend your account. Please notify us at least one month in...
(SPLIT_INFINITIVE)
🪛 markdownlint-cli2 (0.17.2)
docs/01. Glific Overview.md
19-19: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (actions)
|
🚀 Deployed on https://deploy-preview-403--glific-docs.netlify.app |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docusaurus.config.js (2)
85-88: Keep nav/footer destinations consistent with the new overview.The footer still points to “/docs/Introduction”. If the new landing doc is the overview, consider updating this link to the same page for consistency.
Apply if appropriate:
- to: "/docs/Introduction", + to: "/docs/glific-overview",
7-9: Nit: hyphenate the tagline for readability.“An open source two way communication platform” → “An open-source two-way communication platform.”
Suggested change:
- tagline: "An open source two way communication platform", + tagline: "An open-source two-way communication platform",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docusaurus.config.js(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (1)
docusaurus.config.js (1)
65-70: Front-matter ID verifiedThe doc at
docs/01. Glific Overview.mdcontains the front-matter entryid: glific-overviewso the navbar item with
docId: "glific-overview"will resolve correctly.
Summary by CodeRabbit