Skip to content

Conversation

@SangeetaMishr
Copy link
Collaborator

@SangeetaMishr SangeetaMishr commented May 8, 2025

added the new step of adding Partner ID in gupshup steps

Summary by CodeRabbit

  • Documentation
    • Completely overhauled the onboarding guide for setting up an organization on GupShup.
    • Added a step-by-step walkthrough with screenshots and detailed instructions.
    • Embedded a YouTube video tutorial and included notes about future updates.
    • Expanded guidance on account creation, app setup, verification, and integration steps.
    • Included links to external resources and related documentation for further assistance.

added the new step of adding Partner ID in gupshup steps
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 8, 2025

Walkthrough

The documentation for setting up an organization on GupShup has been thoroughly revised and expanded. The update introduces a step-by-step, illustrated onboarding guide, adds a YouTube video tutorial, and incorporates detailed procedural instructions, screenshots, and external resource links, transforming the document into a comprehensive setup manual.

Changes

File(s) Change Summary
docs/2. Onboarding/03. Setup an organisation on GupShup.md Completely rewritten and expanded documentation for GupShup organization setup. Added embedded YouTube video, reformatted prerequisites, detailed step-by-step instructions with screenshots, explicit UI navigation guidance, and references to external resources. Enhanced with additional configuration steps and links to related documentation. No code or exported entity changes.

Poem

In the warren of docs, a new path appears,
With screenshots and steps, it banishes fears.
A video hops in, with guidance so bright,
Each click and each field, now shown in clear light.
On GupShup we leap, with a guide by our side—
Hurrah for the changes, let onboarding be wide!
🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented May 8, 2025

@github-actions github-actions bot temporarily deployed to pull request May 8, 2025 11:34 Inactive
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: 1

🧹 Nitpick comments (7)
docs/2. Onboarding/03. Setup an organisation on GupShup.md (7)

4-8: Use Markdown headings and ensure responsive video embed
Instead of raw HTML <h1>/<h4>, use Markdown syntax (e.g., # Video Tutorial) to stay consistent with the rest of the docs. Also consider making the iframe responsive (e.g., wrapping it in a container with a max-width or using a Markdown video embed helper) so it displays nicely on mobile devices.


14-14: Correct grammar and simplify phrasing
Change “an phone number” to “a phone number” and replace “so as to receive” with “to receive” for clearer, more concise English.

🧰 Tools
🪛 LanguageTool

[misspelling] ~14-~14: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ness%20API/) 1. A new phone number or an phone number that hasn’t been used with...

(EN_A_VS_AN)


[style] ~14-~14: ‘So as to’ expresses purpose and is used in formal texts. Consider using “to”.
Context: ...should be activated with a minimal plan so as to receive sms verification code/call from...

(SO_AS_TO)


28-28: Improve clarity and punctuation
Add a space in “Google (preferred)”, capitalize “email ID”, and rephrase the tail to something like:

“…using a common email ID like info@glific.org so multiple team members can access it if something goes wrong.”


30-30: Consistent casing for 'sign up'
Use the verb form “sign up” instead of the noun “Signup” (e.g., “Complete the sign-up”).


35-38: Refine email and login wording

  • Change “A verification mail” to “A verification email”.
  • Merge the two sentences and correct the verb:

    “Once verification is complete, please log in using your credentials.”

🧰 Tools
🪛 LanguageTool

[misspelling] ~36-~36: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...nt. Once verification is done. Please login using the credentials. ![image](http...

(LOG_IN)


58-58: Clarify naming constraints
Rephrase “(No space or special characters allowed)” to “(No spaces or special characters are allowed)” for grammatical consistency.


182-182: Add missing comma for clarity
Insert a comma before “and” in the sentence:

“…take 3-4 working days to review, and you will receive an email once this is done.”

🧰 Tools
🪛 LanguageTool

[uncategorized] ~182-~182: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ook will take 3-4 working days to review and you will receive an email once this is ...

(COMMA_COMPOUND_SENTENCE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8784a6 and e1a04b1.

📒 Files selected for processing (1)
  • docs/2. Onboarding/03. Setup an organisation on GupShup.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2. Onboarding/03. Setup an organisation on GupShup.md

[misspelling] ~14-~14: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ness%20API/) 1. A new phone number or an phone number that hasn’t been used with...

(EN_A_VS_AN)


[style] ~14-~14: ‘So as to’ expresses purpose and is used in formal texts. Consider using “to”.
Context: ...should be activated with a minimal plan so as to receive sms verification code/call from...

(SO_AS_TO)


[misspelling] ~36-~36: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...nt. Once verification is done. Please login using the credentials. ![image](http...

(LOG_IN)


[uncategorized] ~182-~182: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ook will take 3-4 working days to review and you will receive an email once this is ...

(COMMA_COMPOUND_SENTENCE)

🔇 Additional comments (4)
docs/2. Onboarding/03. Setup an organisation on GupShup.md (4)

23-23: Step 1 instruction looks good
The “Next, go to GupShup.io and click on sign up” step is clear and correctly formatted.


25-25: Skip
The screenshot embed appears correctly formatted and functional.


32-32: Skip
The screenshot embed is fine; just ensure the alt text accurately describes the content for accessibility.


62-62: Skip
The screenshot embed is correctly formatted; just double-check that the alt text describes the image.

Comment on lines +48 to +53
6. Please fill in the **Company/Organization details.**

![image](https://user-images.githubusercontent.com/130072273/233286330-38c97b9e-0eae-4a2c-b809-151201a24722.png)


6. Click on the `Create your first App` button.
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

Fix duplicate step numbers
You have two steps numbered “6.” (fill company details and create first App). This will confuse readers. Renumber the second occurrence as step 7 (and increment all subsequent steps accordingly).

@SangeetaMishr SangeetaMishr requested a review from mahajantejas May 8, 2025 11:38
@mahajantejas mahajantejas merged commit d959921 into main May 9, 2025
7 checks passed
@shijithkjayan shijithkjayan deleted the Setup-an-organisation-on-GupShup.md branch May 21, 2025 11:35
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.

3 participants