Skip to content

Conversation

@amo2003
Copy link
Contributor

@amo2003 amo2003 commented Nov 24, 2025

…ation

This PR fixes minor typographical and grammatical errors in the Custom Connector documentation section.

Changes made:

Changed maven to Maven to maintain correct product name capitalization

Corrected onboard's to onboards to fix incorrect apostrophe usage

These changes improve clarity, readability, and professional tone of the documentation.

Purpose

The documentation currently contains small grammatical and capitalization errors which may reduce clarity and professionalism for readers and developers following the guide. This PR fixes those issues to enhance documentation quality and correctness.
Resolves: Documentation typo and grammar inconsistencies in Custom Connector guide.

Goals

  • Improve readability of the Custom Connector documentation
  • Ensure correct usage of technical terminology and grammar
  • Maintain consistency with official naming conventions (e.g., Maven)

Approach

Reviewed the Custom Connector section and corrected the following:

  • Updated incorrect lowercase use of “maven” to “Maven”
  • Removed incorrect apostrophe in “onboard’s” and replaced it with “onboards”
    Only documentation text was modified; no functional or code changes were made.

User stories

As a developer reading this guide,
I want the documentation to be grammatically correct and professionally written,
So that I can clearly understand and follow the instructions without confusion.

Release note

Minor grammatical and typographical fixes were applied to the Custom Connector documentation to improve clarity and consistency.

Documentation

N/A — This change is a direct documentation improvement.

Training

N/A — No training content changes required.

Certification

N/A — No impact on certification content or exam objectives.

Marketing

N/A — This change does not impact product features or marketing content.

Automation tests

Not applicable (documentation-only change)

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

Security checks

  • Followed secure coding standards: Yes
  • Ran FindSecurityBugs plugin: N/A (documentation-only change)
  • Confirmed no secrets committed: Yes

Samples

N/A — No sample impact

Related PRs

N/A

Migrations (if applicable)

N/A — No migrations required

Test environment

N/A — Documentation-only change

Learning

Through this task, I reinforced the importance of:

  • Attention to detail in technical documentation
  • Correct use of product names and terminology
  • Reviewing guides from a user/developer perspective
    This exercise improved my documentation review and quality assurance skills.

Summary by CodeRabbit

  • Documentation
    • Updated custom connector documentation with minor editorial corrections, including capitalization fixes and improved phrasing for clarity.

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

…ation

This PR fixes minor typographical and grammatical errors in the Custom Connector documentation section.

Changes made:

Changed maven to Maven to maintain correct product name capitalization

Corrected onboard's to onboards to fix incorrect apostrophe usage

These changes improve clarity, readability, and professional tone of the documentation.
@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 updates to the custom AI vendor connector guide with minor editorial corrections including capitalization fixes ("maven" to "Maven"), grammar adjustments ("onboard's" to "onboards"), and spelling standardization ("organisation" spelling).

Changes

Cohort / File(s) Summary
Documentation Editorial Updates
en/docs/ai-gateway/ai-vendor-management/custom-ai-vendors/custom-connector.md
Fixed capitalization of "Maven" in Step 1, corrected grammar in registerLLMProvider description ("onboard's" to "onboards"), and standardized spelling ("organisation"). No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Straightforward editorial corrections with no functional or code logic impact
  • Single documentation file affected with localized wording and spelling fixes

Suggested reviewers

  • chamilaadhi
  • tharikaGitHub

Poem

🐰✨ A hop through the docs with care so fine,
Fixed "Maven" caps and grammar in line,
"Onboards" now flows where "onboard's" once stood,
Small tweaks to words, oh they're all good! 📝

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: fixing typographical and grammatical errors in the Custom Connector documentation.
Description check ✅ Passed The PR description follows the template structure with all major sections completed, including Purpose, Goals, Approach, User stories, Release note, and appropriate N/A entries for non-applicable sections.
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 e63853d.

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

13-13: Minor: Verify consistency of "Maven" capitalization throughout the file.

The capitalization fix for "Maven" appears correct on line 13. However, I notice "Maven" is already capitalized correctly on lines 9 and 11. Please verify that all instances of Maven are consistently capitalized throughout the document.


49-50: Approved: Grammar and spelling corrections look good.

The grammar fix ("onboards" instead of "onboard's") and British English spelling ("organisation" instead of "organization") are appropriate. These changes improve clarity and professionalism. Verify that "organisation" spelling is consistent with the documentation's style guide or locale conventions.


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