docs(auth): document Token Plan setup (endpoint, regions, env key, settings.json example) - #10980
docs(auth): document Token Plan setup (endpoint, regions, env key, settings.json example)#10980now-ing wants to merge 1 commit into
Conversation
…ttings.json example) Add a Token Plan section to docs/users/configuration/auth.md, parallel to the existing Coding Plan section, covering: - Positioning and usage-based billing model for teams/companies - Interactive /auth setup via Alibaba ModelStudio with region selection - A region table with the two dedicated *.maas.aliyuncs.com endpoints (China Beijing / Singapore International) and their consoles - Headless env-var setup using BAILIAN_TOKEN_PLAN_API_KEY - A ready-to-use settings.json example (OpenAI-compatible preset) - A Token Plan row in the 'Removed qwen auth CLI command' migration table - Renumber 'API Key (flexible)' from Option 3 to Option 4 The model list is intentionally not hard-coded (see QwenLM#8432): the section points at the /model picker and endpoint model discovery instead. Closes QwenLM#10620 Signed-off-by: mac <bishopapril850965@yahoo.com>
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
@now-ing Thanks for the docs PR — the description itself is clearly written, and cross-checking every endpoint and env key against the Token Plan preset rather than writing them from memory is exactly the right instinct. Blocking on one administrative thing before anyone spends time on the substance: the PR body doesn't follow the PR template.
Three required sections are missing:
## Risk & Scope— the three bullets (main risk or tradeoff / not validated or out of scope / breaking changes). For this PR it's short: "docs-only, no behavior change", plus what you did not validate — e.g. whether those endpoints were exercised against a live Token Plan account, or read only from the preset source. That distinction is worth stating explicitly, since it's the thing a reviewer can't tell from the diff.## Linked Issues—Closes #10620currently sits inside "Why it's needed". GitHub does pick the closing reference up from there, but the template wants it under its own heading.- The
中文说明<details>block — a full bilingual translation of the English body, paragraph by paragraph. This repo asks for it on every PR, and it's the section most often skipped.
### Environment is explicitly marked optional, so don't bother adding that one.
For context, none of this is new: those sections have been in the template since 2026-05-25, so it's a long-standing requirement rather than something that shifted under you.
Editing the description is enough — no new commit needed. Once those sections are in, re-run triage with @qwen-code /triage and the review will go through the substance: the endpoint / region / env-key claims checked line by line against alibaba-token-plan.ts, and whether the new section overlaps anything already documented.
中文说明
@now-ing 感谢这个文档 PR——描述本身写得很清楚,而且每一个 endpoint 和环境变量都去对照 Token Plan preset 核实、而不是凭记忆写,这个思路完全正确。在有人花时间看实质内容之前,先卡一个流程性问题:PR 正文没有遵循 PR 模板。
缺少三个必填部分:
## Risk & Scope——三个条目(主要风险或取舍 / 未验证或超出范围 / 破坏性变更)。对这个 PR 来说很短:"纯文档改动,无行为变化",再加上你没有验证的部分——比如这些 endpoint 是否用真实的 Token Plan 账号实际调用过,还是只从 preset 源码里读出来的。这个区别值得明确写出来,因为 reviewer 从 diff 里看不出来。## Linked Issues——Closes #10620目前写在 "Why it's needed" 里面。GitHub 确实能从这里识别到关闭引用,但模板要求它单独成节。中文说明的<details>块——把英文正文逐段完整翻译。这是本仓库对每个 PR 的要求,也是最常被漏掉的一节。
### Environment 明确标注为可选,不需要补。
补充背景:这些都不是新要求——模板从 2026-05-25 起就包含这些部分,所以这是长期要求,不是最近才变动的。
只需编辑 PR 描述即可,不需要新的 commit。补齐之后再触发一次 @qwen-code /triage,审查就会进入实质内容:把 endpoint / region / 环境变量的说法逐条对照 alibaba-token-plan.ts 核实,以及新增章节是否与已有文档重复。
— Qwen Code · qwen3.8-max-2026-09-02
|
📄 Docs-only change — the automatic review ran at
Reviewed head: 中文说明📄 纯文档变更 —— 自动评审以 |
What this PR does
Adds a dedicated Alibaba Cloud Token Plan setup section to
docs/users/configuration/auth.md, mirroring the existing Coding Plan section: how to select and configure Token Plan interactively via/auth, a region table (China/Beijing vs Singapore/International endpoints), headless setup via environment variables, and a completesettings.jsonexample. It also adds a Token Plan row to the "Removedqwen authCLI command" migration table.All endpoints, env keys, and protocol details were verified against the codebase preset
packages/core/src/providers/presets/alibaba-token-plan.ts— nothing is hardcoded from memory:BAILIAN_TOKEN_PLAN_API_KEYhttps://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1https://token-plan.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1settings.jsonexample usesmodelProviders.openai/modelpicker and endpoint model discovery, since the preset hassupportsModelDiscovery: true/modelsEditable: truesk-sp-prefix requirement, unlike Coding Plan keysWhy it's needed
Closes #10620. Coding Plan has a full end-to-end setup section while Token Plan was only mentioned in a one-line list entry, leaving Token Plan users without endpoint/region/env-var guidance. The triage on the issue confirmed the gap and the proposed scope.
Reviewer Test Plan
How to verify
Docs-only change. Confirm the new section renders correctly and its facts match the preset source:
docs/users/configuration/auth.mdand check the new## 🪙 Option 3: Alibaba Cloud Token Plansection (structure parallels the Coding Plan section; "API Key (flexible)" became Option 4).packages/core/src/providers/presets/alibaba-token-plan.ts.qwen authnow includes the Token Plan row.Evidence (Before & After)
N/A (docs-only; no behavior change)
Tested on
Validation:
npx prettier --checkpasses on the modified file.