Skip to content

docs(readme): trim the quickstart API-key step to what the quickstart uses - #191

Merged
Birfy merged 2 commits into
mainfrom
claude/busy-hopper-j8iuxw
Sep 16, 2026
Merged

Birfy merged 2 commits into
mainfrom
claude/busy-hopper-j8iuxw

Conversation

@Birfy

@Birfy Birfy commented Sep 16, 2026

Copy link
Copy Markdown
Owner

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 doctor does 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:

  • the two exports, with the "or GLM, a local vLLM, OpenAI itself" hint moved inline onto the base URL;
  • the one sentence that says credentials come from the environment at call time and the base URL picks the provider;
  • agentdescent doctor, and that the demo and pytest -q need no key;
  • a link to Configuring your provider and key for the rest.

Dropped: the provider table, the ANTHROPIC_API_KEY route for claude (the quickstart's model is openai_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 key heading 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.py and tests/test_api_docs.py pass (13 passed). The linked anchor resolves against the ## Configuring your provider and key heading in docs/agents.md.

🤖 Generated with Claude Code

https://claude.ai/code/session_018YNtrWn9WFYPgi3sWxEvSZ


Generated by Claude Code

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
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@Birfy
Birfy merged commit 5eb43c8 into main Sep 16, 2026
2 of 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.

2 participants