-
Notifications
You must be signed in to change notification settings - Fork 14
Adds provider, model vars docs to README #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…for multiple providers.
|
||
We currently support the following secrets, with more to follow as we integrate more providers: | ||
- `OPENAI_API_KEY`: the API key for the "openai" provider | ||
- `ANTHROPIC_API_KEY`: the API key for the "anthropic" provider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could be imagining it but was there a reference to an environment variable glossary somewhere? Consider adding a link somewhere nearby if so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is; it's further down in the document in the "Using from the command line" subsection. Good idea to add a link to it here, too, though, since it elaborates on how API keys are resolved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, the link has been added as of 4e5c235.
Co-authored-by: Dave Bunten <[email protected]>
Thanks, @falquaddoomi, for this PR and @d33bs for the review. If you don't mind, I will take a look at the new release after this is merged, so I can test it with manuscripts we have. Let me know, though, if you need me to look at this PR at this stage. |
Co-authored-by: Dave Bunten <[email protected]>
…s to their own line.
The upcoming rootstock PR manubot/rootstock#522 adds a few new optional repo variables and secrets, specifically:
AI_EDITOR_MODEL_PROVIDER
which specifies a default model provider when "(repo default)" is selected in the workflow model provider dropdown, andAI_EDITOR_LANGUAGE_MODEL
which specifies a default model to useThe new rootstock PR allows provider-specific API keys in addition to the generic
PROVIDER_API_KEY
already mentioned in the docs.This PR adds the two variables mentioned above plus these new API key secrets to the README section regarding setting up a rootstock fork and running the ai-editor workflow.