Skip to content

[codex] docs: update OpenAI SDK requirement#6300

Open
aditya-vithaldas wants to merge 1 commit into
crewAIInc:mainfrom
aditya-vithaldas:codex/update-openai-sdk-docs
Open

[codex] docs: update OpenAI SDK requirement#6300
aditya-vithaldas wants to merge 1 commit into
crewAIInc:mainfrom
aditya-vithaldas:codex/update-openai-sdk-docs

Conversation

@aditya-vithaldas

@aditya-vithaldas aditya-vithaldas commented Jun 23, 2026

Copy link
Copy Markdown

Summary

  • Updates the Edge installation docs to match the current OpenAI SDK dependency range from lib/crewai/pyproject.toml.
  • Applies the same correction to the English and Arabic installation pages.

Why

The docs still referenced CrewAI 0.175.0 and openai >= 1.13.3, while the current package metadata requires openai>=2.30.0,<3. This could mislead users who manage dependencies manually.

Closes #6299.

Validation

  • git diff --check
  • Verified the docs lines now match lib/crewai/pyproject.toml

Summary by CodeRabbit

  • Documentation
    • Updated OpenAI SDK dependency requirement from >=1.13.3 to >=2.30.0,<3 in installation guides.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 83f6cd3f-0cbe-408f-950a-d0b17abb2c5e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Two installation documentation files (docs/edge/en/installation.mdx and docs/edge/ar/installation.mdx) have their stated openai SDK version constraint updated from >= 1.13.3 to >=2.30.0,<3 to match the current pyproject.toml dependency metadata.

Changes

Installation Docs openai SDK Requirement

Layer / File(s) Summary
openai version constraint update
docs/edge/en/installation.mdx, docs/edge/ar/installation.mdx
The OpenAI SDK Requirement note in both the English and Arabic edge installation guides is updated from openai >= 1.13.3 to openai >=2.30.0,<3.

Suggested Reviewers

  • vinibrsl
  • joaomdmoura
  • gabemilani
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change: updating OpenAI SDK requirements in documentation.
Linked Issues check ✅ Passed The PR successfully addresses all requirements from issue #6299 by updating OpenAI SDK versions from 1.13.3 to 2.30.0,<3 in both English and Arabic installation docs.
Out of Scope Changes check ✅ Passed All changes are directly scoped to updating OpenAI SDK requirements in Edge installation documentation; no extraneous modifications are present.
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

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.

@corridor-security corridor-security Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary: This PR updates Edge installation documentation to reflect the current OpenAI SDK dependency constraint and does not alter runtime code, authentication, authorization, or data handling.

Risk: Low risk. The changes are documentation-only, and no exploitable security vulnerabilities were identified.

@aditya-vithaldas aditya-vithaldas marked this pull request as ready for review June 23, 2026 10:28
@aditya-vithaldas

Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@aditya-vithaldas

Copy link
Copy Markdown
Author

All visible checks are passing, and CodeRabbit reported no actionable comments. This is ready for maintainer review/merge when convenient.

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.

Docs: update stale OpenAI SDK requirement in installation guide

1 participant