Repository navigation
docs(readme): trim the quickstart API-key step to what the quickstart uses - #191
Merged
Merged
Conversation
The first version answered questions nobody asks at the quickstart: what a CLI worker inherits, what `doctor` does and does not print, a four-row table of base URLs. That belongs on the agents page, which already has it, and length on a README is what makes a step get skipped. Keep the two exports, the one sentence that says the base URL picks the provider, and Claude's separate variable; link the rest. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018YNtrWn9WFYPgi3sWxEvSZ
The quickstart's model is `openai_compatible`, so ANTHROPIC_API_KEY is a second path a reader does not need at that point. The agents page the step already links covers it. 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
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
Follow-up to #190, which merged the first draft of the API-key step. That draft answered questions nobody asks at the quickstart — a four-row base-URL table, what a CLI worker inherits, what
doctordoes and does not print — and ran 30 lines before the code block it was introducing. Length on a README is what makes a step get skipped, and every one of those details already lives on the agents page.What changed
The section shrinks from 30 lines to 12, keeping only the path the quickstart itself takes:
exports, with the "or GLM, a local vLLM, OpenAI itself" hint moved inline onto the base URL;agentdescent doctor, and that the demo andpytest -qneed no key;Dropped: the provider table, the
ANTHROPIC_API_KEYroute forclaude(the quickstart's model isopenai_compatible, so it is a second path a reader does not need at that point), the CLI-worker inheritance note, and the shell-profile line. The### First, your API keyheading becomes a bold lead-in — the README uses no other###.Net
README.md: +7 / −26. 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.🤖 Generated with Claude Code
https://claude.ai/code/session_018YNtrWn9WFYPgi3sWxEvSZ
Generated by Claude Code