Skip to content

docs: clarify provider setup#888

Merged
dersam merged 2 commits into
Shopify:mainfrom
omribz156:codex/provider-setup-docs
Jun 2, 2026
Merged

docs: clarify provider setup#888
dersam merged 2 commits into
Shopify:mainfrom
omribz156:codex/provider-setup-docs

Conversation

@omribz156
Copy link
Copy Markdown
Contributor

Summary

  • Clarify that Roast provider settings are selected in workflow config blocks.
  • Document the current chat provider setup (OPENAI_API_KEY, optional OPENAI_API_BASE, and provider :openai).
  • Document the current agent providers (:claude and :pi) and note that agent CLIs must be installed/authenticated separately.
  • Note that there is not currently a CLI flag or environment variable for changing the default provider globally.

Closes #813

Verification

  • git diff --check

I could not run bundle exec rake in this workspace because Ruby/Bundler is not installed locally. This is a README-only change.

This was implemented with Codex assistance, with the final diff reviewed against the provider configuration source.

@omribz156
Copy link
Copy Markdown
Contributor Author

I have signed the CLA!

@dersam dersam merged commit 8e71069 into Shopify:main Jun 2, 2026
3 checks passed
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.

Improve setup instructions to include how to configure API keys/providers

2 participants