Repository navigation
docs(readme): show how to configure an API key in the quickstart - #190
Merged
Merged
Conversation
The quickstart's first line that talks to a model is `openai_compatible(model="deepseek-v4-flash")`, and nothing on the page said where the credentials come from -- a reader had to follow a link to the docs site to find out that the base URL is what picks the provider, or that OPENAI_API_KEY against the default base URL means OpenAI and nothing else. Add a "First, your API key" step ahead of the code block: the two variables `openai_compatible` reads, a base-URL table for DeepSeek, GLM, OpenAI and a local server, the separate ANTHROPIC_API_KEY path for `claude`, what a CLI worker does and does not inherit, and `agentdescent doctor` for checking a machine. Wording follows docs/agents.md so the two cannot say different things. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018YNtrWn9WFYPgi3sWxEvSZ
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The quickstart's first line that talks to a model is
openai_compatible(model="deepseek-v4-flash"), and nothing on the page said where the credentials come from. A reader had to follow a link to the docs site to learn that the base URL is what picks the provider — or thatOPENAI_API_KEYagainst the default base URL means OpenAI and nothing else.What changed
A short "Set your key first" paragraph ahead of the quickstart code block in
README.md— three lines of prose, twoexports, and a link:openai_compatiblereads, and that the base URL is what picks the provider;agentdescent doctorfor checking a machine, and a note that the demo andpytest -qneed no key at all;Only the path the quickstart actually takes is spelled out. The per-provider base-URL table, the
ANTHROPIC_API_KEYroute forclaude, and what a CLI worker inherits stay on the agents page that already documents them, so the README stays skimmable and the two pages cannot drift. No code changes.Verification
tests/test_docs_links.py,tests/test_docs_examples.pyandtests/test_api_docs.pypass (13 passed). The linked anchor resolves against the## Configuring your provider and keyheading indocs/agents.md.Not included
docs/quickstart-skill.mdhas the same gap — it shows the sameopenai_compatiblecall with no key setup, while onlydocs/install.mdanddocs/agents.mdcover it. Left out as out of scope for this change; happy to follow up.🤖 Generated with Claude Code
https://claude.ai/code/session_018YNtrWn9WFYPgi3sWxEvSZ