Skip to content

Conversation

@amo2003
Copy link
Contributor

@amo2003 amo2003 commented Nov 24, 2025

This PR fixes a minor grammatical error in the Custom Connector documentation.

  • Corrected "responsible of handling" to "responsible for handling" to improve clarity and English correctness.

Purpose

Fix a minor grammatical error in the Custom Connector documentation to improve clarity and correctness.
No related GitHub issues.

Goals

Ensure the documentation uses correct English and is easy for developers to understand.

Approach

Updated a single sentence in the Custom Connector documentation by changing: responsible of handling → responsible for handling
No UI changes were made.

User stories

N/A – This is a minor documentation improvement.>

Release note

Fixed a minor grammatical error in the Custom Connector documentation.

Documentation

This PR directly updates the Custom Connector documentation to improve grammar and readability.

Training

N/A – No impact on training content.

Certification

N/A – This documentation-only change does not impact certification content.

Marketing

N/A – No marketing content is affected.

Automation tests

  • Unit tests: N/A
  • Integration tests: N/A

Security checks

  • Followed secure coding standards? Yes
  • Ran FindSecurityBugs plugin and verified report? N/A
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? Yes

Samples

N/A – No code or functional changes were introduced.

Related PRs

N/A

Migrations (if applicable)

No migration required.

Test environment

Tested via GitHub preview (Markdown rendering only).

Learning

Reviewed WSO2 documentation writing conventions and improved understanding of maintaining consistent and clear technical documentation.

Summary by CodeRabbit

  • Documentation
    • Corrected capitalization and grammar throughout the AI vendor management documentation.
    • Fixed spelling inconsistencies and improved clarity of technical instructions and deployment steps.

✏️ Tip: You can customize this high-level summary in your review settings.

This PR fixes a minor grammatical error in the Custom Connector documentation.

- Corrected "responsible of handling" to "responsible for handling" to improve clarity and English correctness.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link

coderabbitai bot commented Nov 24, 2025

Walkthrough

Documentation file corrected for capitalization, grammar, spelling standardization, and wording improvements. Changes include "maven" → "Maven", grammar fixes for verb conjugation, standardized spelling conventions, and simplified phrasing.

Changes

Cohort / File(s) Summary
Documentation corrections
en/docs/ai-gateway/ai-vendor-management/custom-ai-vendors/custom-connector.md
Fixed capitalization ("maven" → "Maven"), corrected grammar ("onboard's the provider" → "onboards the provider"), standardized spelling ("organisation's name"), and improved wording ("add it in to" → "add it to")

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single documentation file with straightforward text corrections
  • No logic, code, or functional changes
  • Purely cosmetic and grammatical fixes

Suggested reviewers

  • chamilaadhi
  • tharikaGitHub

Poem

🐰 A hop and a bound through words so fine,
Grammar and caps now perfectly align,
From "onboard's" missteps to clarity true,
The docs shine brighter—fresh as morning dew!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning Title mentions '(of → for)' correction, but the raw summary shows multiple different corrections (capitalization, possessive/conjugation, spelling, and prepositions), with no specific mention of the 'of → for' change described. Update the title to accurately reflect the main grammatical fixes made, such as 'Fix grammar and capitalization in Custom Connector documentation' or verify the actual changes match the title's claim.
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The PR description is comprehensive and follows the template structure, addressing all major sections including Purpose, Goals, Approach, and appropriate N/A entries where applicable.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e79e04f and 69d4f64.

📒 Files selected for processing (1)
  • en/docs/ai-gateway/ai-vendor-management/custom-ai-vendors/custom-connector.md (3 hunks)
🔇 Additional comments (3)
en/docs/ai-gateway/ai-vendor-management/custom-ai-vendors/custom-connector.md (3)

13-13: Correct grammar fix applied.

The change from "responsible of" to "responsible for" correctly applies the proper preposition for this context.


67-67: Wording improvement applied.

The change from "add it in to" to "add it to" removes redundant phrasing and improves clarity.


49-49: I need to check the broader documentation for English variant consistency to verify the review comment's assessment.

I need to check the documentation's broader English variant usage patterns to verify if the review comment's suggestion is valid.

Based on my verification, the review comment identifies a valid concern. The spelling difference lies in regional preference: "organization" is standard in American English, while "organisation" is commonly used in British English. The review correctly notes that consistency is key within a single document.

However, the Cloudflare style guide search did not reveal an explicit English variant preference. The review comment's suggestion to verify consistency across the documentation is sound, but without seeing the broader file context or a definitive style guide specification, I cannot confirm whether "organisation" is truly inconsistent with the rest of the codebase.

Verify English variant consistency in the documentation.

The review comment's grammar fixes appear valid ("onboards" and "organisation's name" are both grammatically correct). However, before standardizing to American English as suggested, confirm whether the broader Cloudflare documentation uses British or American English variants. Check the documentation's explicit style guidelines or sample multiple files in the en/docs directory to establish the project's English variant convention. If American English is the standard, update "organisation" to "organization" for consistency; otherwise, preserve the current British English usage if it aligns with project conventions.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

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.

2 participants