Skip to content

docs: clarify OrkesClients works with OSS Conductor, no account required#403

Open
nthmost-orkes wants to merge 1 commit intomainfrom
docs/orkes-clients-naming-note
Open

docs: clarify OrkesClients works with OSS Conductor, no account required#403
nthmost-orkes wants to merge 1 commit intomainfrom
docs/orkes-clients-naming-note

Conversation

@nthmost-orkes
Copy link
Copy Markdown
Contributor

Summary

  • Added a callout note after the quickstart Run it: block explaining that OrkesClients works with self-hosted OSS Conductor and requires no Orkes account
  • Added # works with OSS Conductor and Orkes Conductor comment to the second OrkesClients import in the Feature Showcase section (first import already had this comment)

User impact: First-time OSS users following the quickstart saw a class named OrkesClients and reasonably wondered if they needed an Orkes account or paid service. Now there's a visible note right where they're most likely to pause — immediately after running the app — making it clear the name reflects the implementing org, not a cloud requirement.

Closes conductor-oss/getting-started#45 (doc-only fix; the ConductorClients alias discussed in that issue remains open as a separate low-priority enhancement).

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 57 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Python SDK: OrkesClients class name is confusing for OSS users — implies Orkes account required

1 participant