Skip to content

Comments

Revise WhatsApp Forms documentation and update details#578

Open
mahajantejas wants to merge 1 commit intomainfrom
whatsapp-forms-phase2
Open

Revise WhatsApp Forms documentation and update details#578
mahajantejas wants to merge 1 commit intomainfrom
whatsapp-forms-phase2

Conversation

@mahajantejas
Copy link
Collaborator

@mahajantejas mahajantejas commented Feb 24, 2026

Updated the last updated date and modified the steps for creating WhatsApp forms, including new instructions for data storage and form submission based on the forms phase 2 implementation

Summary by CodeRabbit

  • Documentation
    • Updated WhatsApp Forms guide with simplified creation workflow
    • Added comprehensive Form Builder interface documentation and field terminology clarification
    • Included form creation checklist and updated guidance for sending forms to users
    • Refreshed screenshots and removed outdated content
    • Added details on form content types and multilingual support

Updated the last updated date and modified the steps for creating WhatsApp forms, including new instructions for data storage and form submission based on the forms phase 2 implementation
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 24, 2026

📝 Walkthrough

Walkthrough

This pull request updates the WhatsApp Forms documentation, restructuring the creation flow to emphasize the form builder interface and removing outdated references. The document transitions from iframe-heavy publishing instructions to a comprehensive guide covering form creation, builder features, field configuration, and lifecycle states.

Changes

Cohort / File(s) Summary
WhatsApp Forms Documentation
docs/4. Product Features/WhatsApp Forms.md
Restructured creation flow with streamlined steps; introduced Form Builder section detailing field types, options, and actions; added form creation checklist and updated guidance for submitting forms; removed deprecated Meta Playground references and iframe embeds; updated timestamp to February 2026.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • SangeetaMishr
  • Fawas003

Poem

🐰 Forms flow smoother now, structured with care,
Builder interface shining bright and fair,
Old iframes faded, new screenshots gleam,
WhatsApp Forms documentation—a streamlined dream! ✨📋

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Revise WhatsApp Forms documentation and update details' is vague and generic, using non-descriptive terms like 'update details' that don't convey specific information about the changes. Consider a more specific title that highlights the main change, such as 'Update WhatsApp Forms documentation for phase 2 implementation' or 'Revise WhatsApp Forms creation flow and form builder documentation'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch whatsapp-forms-phase2

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

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: 4

🤖 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/4`. Product Features/WhatsApp Forms.md:
- Line 46: The document uses the lowercase proper noun "google" in phrases like
"google sheet" and "google service account" (e.g., the text "add a `google
sheet` with write access to the google service account"); update these
occurrences to use the correct capitalization "Google" (e.g., "Google Sheet",
"Google service account") consistently throughout the file, including the
instances referenced at lines 46, 96, and 128.
- Around line 55-58: The doc uses two different lifecycle terms—“Submit to Meta”
(button/step label) and “published” (descriptive state); pick one term and make
it consistent across the guide and FAQs (replace occurrences of “published” with
“Submit to Meta” or vice versa), update the Form Features section lines
referencing the final step (e.g., the “Submit to Meta” button text) and the
FAQ/other sections (previously lines ~223-226 and ~239-245) so they use the
chosen term consistently, and keep the immutability note (“once the form is
submitted to meta, it cannot be changed further”) aligned to the chosen
terminology.
- Around line 42-48: The ordered step lists in WhatsApp Forms.md have skipped
numbers (e.g., 1,2,3,4,6) which breaks continuity; update each "Steps:" ordered
list so numbering is sequential and continuous (e.g., change the block that
currently reads 1,2,3,4,6 to 1,2,3,4,5) and repeat the same fix for the other
occurrences referenced (the lists around lines 61-65 and 154-156); ensure every
"Steps:" section and its items are renumbered to a consecutive sequence without
gaps so users can follow instructions linearly.
- Line 121: The emphasis contains trailing spaces ("**Implications of the id
**"); remove the extra space inside the bold markers so the text reads
"**Implications of the id**" to satisfy markdownlint MD037 and render correctly;
update the heading in the WhatsApp Forms document where the string "Implications
of the id **" appears.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5d1dec and 8d4eea4.

📒 Files selected for processing (1)
  • docs/4. Product Features/WhatsApp Forms.md

Comment on lines 42 to +48
Steps:
1. Go to `Quick Tools` → `WhatsApp Forms` in Glific.
2. Click `Create Form`
3. Go to WhatsApp Flows Playground to get a friendly interface to create your form
4. Choose field types and design your form (text input, radio, multi-select, etc.)
5. Click on `copy flow JSON` after completing the form design
6. Paste the Flow JSON into the `form JSON` input field
7. Give your form an appropriate `title`, `description` and `category`
8. Click on `Save`
9. This creates a draft of the form
10. On the `WhatsApp Forms` Listing page, click on the publish icon to publish the form.
2. Click `Create` Form
3. Provide a form `title` and `category`
4. For data storage, add a `google sheet` with write access to the google service account to automatically capture the responses to the form. This step is optional. A google sheet can be added before the form is `submitted to Meta`
6. Click on Save and go to the form builder interface
<img width="568" height="386" alt="Screenshot 2026-02-24 at 3 51 24 PM" src="https://github.com/user-attachments/assets/15e81cc8-0da5-43a0-95fd-298177bb567a" />
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 | 🟡 Minor

Fix broken step numbering.

There are skipped numbers in multiple step lists (e.g., 4→6, 2→4, 1→3), which makes the instructions hard to follow. Please renumber for continuity.

Also applies to: 61-65, 154-156

🧰 Tools
🪛 LanguageTool

[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...google sheet with write access to the google service account to automatically captur...

(A_GOOGLE)


[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...s to the form. This step is optional. A google sheet can be added before the form is `...

(A_GOOGLE)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 42 - 48, The ordered
step lists in WhatsApp Forms.md have skipped numbers (e.g., 1,2,3,4,6) which
breaks continuity; update each "Steps:" ordered list so numbering is sequential
and continuous (e.g., change the block that currently reads 1,2,3,4,6 to
1,2,3,4,5) and repeat the same fix for the other occurrences referenced (the
lists around lines 61-65 and 154-156); ensure every "Steps:" section and its
items are renumbered to a consecutive sequence without gaps so users can follow
instructions linearly.

10. On the `WhatsApp Forms` Listing page, click on the publish icon to publish the form.
2. Click `Create` Form
3. Provide a form `title` and `category`
4. For data storage, add a `google sheet` with write access to the google service account to automatically capture the responses to the form. This step is optional. A google sheet can be added before the form is `submitted to Meta`
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 | 🟡 Minor

Capitalize “Google” consistently.

Multiple instances use “google” in running text. Please capitalize the proper noun.

Also applies to: 96-96, 128-128

🧰 Tools
🪛 LanguageTool

[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...google sheet with write access to the google service account to automatically captur...

(A_GOOGLE)


[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...s to the form. This step is optional. A google sheet can be added before the form is `...

(A_GOOGLE)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md at line 46, The document uses the
lowercase proper noun "google" in phrases like "google sheet" and "google
service account" (e.g., the text "add a `google sheet` with write access to the
google service account"); update these occurrences to use the correct
capitalization "Google" (e.g., "Google Sheet", "Google service account")
consistently throughout the file, including the instances referenced at lines
46, 96, and 128.

Comment on lines +55 to +58
1. Form Json - this allows you to toggle to the from json view, and edit things in the form json as it gets developed by adding screens and components from
2. Save Draft - while the changes being made are auto-saved, this button is provided as a back-up.
3. Submit to Meta - this is the final step of form creation. Click on `Submit to meta` once the form is ready to be used by over WhatsApp. Please note: once the form is submitted to meta, it cannot be changed further. To make changes, a new form will need to be created and modified.

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 | 🟠 Major

Align lifecycle terminology (“Submit to Meta” vs “published”).

The doc states forms must be “submitted to Meta” and then later says they must be “published.” These appear to describe the same lifecycle step; inconsistent terminology will confuse users. Please standardize on one term across the guide and FAQs.

Also applies to: 223-226, 239-245

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 55 - 58, The doc
uses two different lifecycle terms—“Submit to Meta” (button/step label) and
“published” (descriptive state); pick one term and make it consistent across the
guide and FAQs (replace occurrences of “published” with “Submit to Meta” or vice
versa), update the Form Features section lines referencing the final step (e.g.,
the “Submit to Meta” button text) and the FAQ/other sections (previously lines
~223-226 and ~239-245) so they use the chosen term consistently, and keep the
immutability note (“once the form is submitted to meta, it cannot be changed
further”) aligned to the chosen terminology.


<img width="1242" height="833" alt="Screenshot 2026-02-24 at 4 51 15 PM" src="https://github.com/user-attachments/assets/650469e6-9068-4434-9ecf-149df19d11ca" />

**Implications of the id **
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 | 🟡 Minor

Remove extra spaces inside emphasis.

The emphasis marker has trailing space: **Implications of the id **. This trips markdownlint (MD037) and renders oddly.

✅ Suggested fix
-**Implications of the id **
+**Implications of the id**
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Implications of the id **
**Implications of the id**
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 121-121: Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md at line 121, The emphasis
contains trailing spaces ("**Implications of the id **"); remove the extra space
inside the bold markers so the text reads "**Implications of the id**" to
satisfy markdownlint MD037 and render correctly; update the heading in the
WhatsApp Forms document where the string "Implications of the id **" appears.

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.

1 participant