From 6f295e99617451c8d3407f2af212ba2bc9038f69 Mon Sep 17 00:00:00 2001 From: Hunter B Date: Sun, 31 May 2026 17:43:46 -0700 Subject: [PATCH] docs: sync release credit surfaces --- CHANGELOG.md | 8 ++ README.ja-JP.md | 4 + README.md | 11 +++ README.vi.md | 4 + README.zh-CN.md | 4 + crates/tui/CHANGELOG.md | 8 ++ docs/RELEASE_CHECKLIST.md | 17 ++++- web/app/[locale]/faq/page.tsx | 42 ++++++----- web/app/[locale]/install/page.tsx | 64 ++++++++-------- web/app/[locale]/page.tsx | 117 +++++++++++++++++++++++++++++- web/app/[locale]/roadmap/page.tsx | 12 +-- web/lib/facts.generated.ts | 22 +++++- web/lib/github.test.ts | 35 +-------- web/lib/github.ts | 2 +- web/scripts/derive-facts.mjs | 3 + 15 files changed, 255 insertions(+), 98 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b883941..b3532192 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -112,6 +112,14 @@ Thanks to contributors whose PRs landed or were harvested in this release: **@hoclaptrinh33** (#2358), and **@BryonGo** (#2437). +Thanks also to reporters and verification helpers whose issues, patches, +screenshots, logs, or retest requests shaped this release: **@buko** (#2359, +#2360, #2369, #2469), **@yyyCode**, **@gaslebinh-glitch**, **@Dr3259**, +**@lpeng1711694086-lang**, **@VerrPower**, **@yan-zay**, **@jretz**, +**@Neo-millunnium**, **@caeserchen**, **@T-Phuong-Nguyen**, **@zhyuzhyu**, +**@0gl20shk0sbt36**, **@hatakes**, **@goodvecn-dev**, **@bevis-wong**, +**@PurplePulse**, and **@nbiish**. + ## [0.8.47] - 2026-05-26 ### Added diff --git a/README.ja-JP.md b/README.ja-JP.md index 37c380cc..a8bc867a 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -422,6 +422,10 @@ description: DeepSeek にカスタムワークフローを実行させたいと このプロジェクトは、増え続けるコントリビューターのコミュニティから助けを得て出荷されています: +v0.8.48 でマージまたは取り込まれた貢献者: **[@cy2311](https://github.com/cy2311)**、**[@LING71671](https://github.com/LING71671)**、**[@axobase001](https://github.com/axobase001)**、**[@dzyuan](https://github.com/dzyuan)**、**[@mvanhorn](https://github.com/mvanhorn)**、**[@malsony](https://github.com/malsony)**、**[@gaord](https://github.com/gaord)**、**[@yuanchenglu](https://github.com/yuanchenglu)**、**[@idling11](https://github.com/idling11)**、**[@h3c-hexin](https://github.com/h3c-hexin)**、**[@AdityaVG13](https://github.com/AdityaVG13)**、**[@Sskift](https://github.com/Sskift)**、**[@cyq1017](https://github.com/cyq1017)**、**[@HUQIANTAO](https://github.com/HUQIANTAO)**、**[@New2Niu](https://github.com/New2Niu)**、**[@AiurArtanis](https://github.com/AiurArtanis)**、**[@Lee-take](https://github.com/Lee-take)**、**[@nightt5879](https://github.com/nightt5879)**、**[@AresNing](https://github.com/AresNing)**、**[@AccMoment](https://github.com/AccMoment)**、**[@reidliu41](https://github.com/reidliu41)**、**[@aboimpinto](https://github.com/aboimpinto)**、**[@zhuangbiaowei](https://github.com/zhuangbiaowei)**、**[@donglovejava](https://github.com/donglovejava)**、**[@hongqitai](https://github.com/hongqitai)**、**[@zlh124](https://github.com/zlh124)**、**[@encyc](https://github.com/encyc)**、**[@Implementist](https://github.com/Implementist)**、**[@lihuan215](https://github.com/lihuan215)**、**[@LeoAlex0](https://github.com/LeoAlex0)**、**[@jimmyzhuu](https://github.com/jimmyzhuu)**、**[@rockyzhang](https://github.com/rockyzhang)**、**[@mo-vic](https://github.com/mo-vic)**、**[@hufanexplore](https://github.com/hufanexplore)**、**[@hoclaptrinh33](https://github.com/hoclaptrinh33)**、**[@BryonGo](https://github.com/BryonGo)**。 + +報告、再現手順、検証で v0.8.48 を支えてくれた **[@buko](https://github.com/buko)**、**[@yyyCode](https://github.com/yyyCode)**、**[@gaslebinh-glitch](https://github.com/gaslebinh-glitch)**、**[@Dr3259](https://github.com/Dr3259)**、**[@lpeng1711694086-lang](https://github.com/lpeng1711694086-lang)**、**[@VerrPower](https://github.com/VerrPower)**、**[@yan-zay](https://github.com/yan-zay)**、**[@jretz](https://github.com/jretz)**、**[@Neo-millunnium](https://github.com/Neo-millunnium)**、**[@caeserchen](https://github.com/caeserchen)**、**[@T-Phuong-Nguyen](https://github.com/T-Phuong-Nguyen)**、**[@zhyuzhyu](https://github.com/zhyuzhyu)**、**[@0gl20shk0sbt36](https://github.com/0gl20shk0sbt36)**、**[@hatakes](https://github.com/hatakes)**、**[@goodvecn-dev](https://github.com/goodvecn-dev)**、**[@bevis-wong](https://github.com/bevis-wong)**、**[@PurplePulse](https://github.com/PurplePulse)**、**[@nbiish](https://github.com/nbiish)** にも感謝します。 + - **[merchloubna70-dot](https://github.com/merchloubna70-dot)** — 機能、修正、VS Code 拡張のスキャフォールドにまたがる 28 件の PR (#645–#681) - **[WyxBUPT-22](https://github.com/WyxBUPT-22)** — 表、太字／斜体、水平線の Markdown レンダリング (#579) - **[loongmiaow-pixel](https://github.com/loongmiaow-pixel)** — Windows と中国向けインストールドキュメント (#578) diff --git a/README.md b/README.md index ddf98e1d..c8e90ac5 100644 --- a/README.md +++ b/README.md @@ -705,6 +705,17 @@ This project ships with help from a growing community of contributors: - **[hongqitai](https://github.com/hongqitai)** — state schema parent-entry support and clippy/fmt cleanup (#2308, #2432) - **[BryonGo](https://github.com/BryonGo)** — effective-model compaction budgeting fix (#2437) +Reports, repros, and verification that shaped v0.8.48 also deserve visible +credit: **[@buko](https://github.com/buko)**, **[@yyyCode](https://github.com/yyyCode)**, +**[@gaslebinh-glitch](https://github.com/gaslebinh-glitch)**, **[@Dr3259](https://github.com/Dr3259)**, +**[@lpeng1711694086-lang](https://github.com/lpeng1711694086-lang)**, **[@VerrPower](https://github.com/VerrPower)**, +**[@yan-zay](https://github.com/yan-zay)**, **[@jretz](https://github.com/jretz)**, +**[@Neo-millunnium](https://github.com/Neo-millunnium)**, **[@caeserchen](https://github.com/caeserchen)**, +**[@T-Phuong-Nguyen](https://github.com/T-Phuong-Nguyen)**, **[@zhyuzhyu](https://github.com/zhyuzhyu)**, +**[@0gl20shk0sbt36](https://github.com/0gl20shk0sbt36)**, **[@hatakes](https://github.com/hatakes)**, +**[@goodvecn-dev](https://github.com/goodvecn-dev)**, **[@bevis-wong](https://github.com/bevis-wong)**, +**[@PurplePulse](https://github.com/PurplePulse)**, and **[@nbiish](https://github.com/nbiish)**. + --- ## Contributing diff --git a/README.vi.md b/README.vi.md index 91f39d19..4ca618d3 100644 --- a/README.vi.md +++ b/README.vi.md @@ -509,6 +509,10 @@ Lịch sử cập nhật chi tiết: [CHANGELOG.md](CHANGELOG.md). Dự án này được phát triển và vận hành trơn tru với sự đóng góp của cộng đồng các nhà phát triển ngày càng lớn mạnh: +Các đóng góp đã được merge hoặc được harvest trong v0.8.48: **[@cy2311](https://github.com/cy2311)**, **[@LING71671](https://github.com/LING71671)**, **[@axobase001](https://github.com/axobase001)**, **[@dzyuan](https://github.com/dzyuan)**, **[@mvanhorn](https://github.com/mvanhorn)**, **[@malsony](https://github.com/malsony)**, **[@gaord](https://github.com/gaord)**, **[@yuanchenglu](https://github.com/yuanchenglu)**, **[@idling11](https://github.com/idling11)**, **[@h3c-hexin](https://github.com/h3c-hexin)**, **[@AdityaVG13](https://github.com/AdityaVG13)**, **[@Sskift](https://github.com/Sskift)**, **[@cyq1017](https://github.com/cyq1017)**, **[@HUQIANTAO](https://github.com/HUQIANTAO)**, **[@New2Niu](https://github.com/New2Niu)**, **[@AiurArtanis](https://github.com/AiurArtanis)**, **[@Lee-take](https://github.com/Lee-take)**, **[@nightt5879](https://github.com/nightt5879)**, **[@AresNing](https://github.com/AresNing)**, **[@AccMoment](https://github.com/AccMoment)**, **[@reidliu41](https://github.com/reidliu41)**, **[@aboimpinto](https://github.com/aboimpinto)**, **[@zhuangbiaowei](https://github.com/zhuangbiaowei)**, **[@donglovejava](https://github.com/donglovejava)**, **[@hongqitai](https://github.com/hongqitai)**, **[@zlh124](https://github.com/zlh124)**, **[@encyc](https://github.com/encyc)**, **[@Implementist](https://github.com/Implementist)**, **[@lihuan215](https://github.com/lihuan215)**, **[@LeoAlex0](https://github.com/LeoAlex0)**, **[@jimmyzhuu](https://github.com/jimmyzhuu)**, **[@rockyzhang](https://github.com/rockyzhang)**, **[@mo-vic](https://github.com/mo-vic)**, **[@hufanexplore](https://github.com/hufanexplore)**, **[@hoclaptrinh33](https://github.com/hoclaptrinh33)** và **[@BryonGo](https://github.com/BryonGo)**. + +Xin cảm ơn các báo cáo, bước tái hiện lỗi và xác minh từ **[@buko](https://github.com/buko)**, **[@yyyCode](https://github.com/yyyCode)**, **[@gaslebinh-glitch](https://github.com/gaslebinh-glitch)**, **[@Dr3259](https://github.com/Dr3259)**, **[@lpeng1711694086-lang](https://github.com/lpeng1711694086-lang)**, **[@VerrPower](https://github.com/VerrPower)**, **[@yan-zay](https://github.com/yan-zay)**, **[@jretz](https://github.com/jretz)**, **[@Neo-millunnium](https://github.com/Neo-millunnium)**, **[@caeserchen](https://github.com/caeserchen)**, **[@T-Phuong-Nguyen](https://github.com/T-Phuong-Nguyen)**, **[@zhyuzhyu](https://github.com/zhyuzhyu)**, **[@0gl20shk0sbt36](https://github.com/0gl20shk0sbt36)**, **[@hatakes](https://github.com/hatakes)**, **[@goodvecn-dev](https://github.com/goodvecn-dev)**, **[@bevis-wong](https://github.com/bevis-wong)**, **[@PurplePulse](https://github.com/PurplePulse)** và **[@nbiish](https://github.com/nbiish)** đã giúp định hình v0.8.48. + - **[merchloubna70-dot](https://github.com/merchloubna70-dot)** — Đóng góp 28 PR bao gồm tính năng mới, sửa lỗi và dựng sẵn extension cho VS Code (#645–#681) - **[WyxBUPT-22](https://github.com/WyxBUPT-22)** — Xây dựng trình kết xuất Markdown hỗ trợ bảng biểu, chữ đậm/nghiêng và đường kẻ ngang (#579) - **[loongmiaow-pixel](https://github.com/loongmiaow-pixel)** — Tài liệu cài đặt cho Windows và Trung Quốc (#578) diff --git a/README.zh-CN.md b/README.zh-CN.md index 03a0975f..25cffab2 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -537,6 +537,10 @@ description: 当 DeepSeek 需要遵循我的自定义工作流时使用这个技 本项目由不断壮大的贡献者社区共同打造： +v0.8.48 合并或吸收的贡献者包括：**[@cy2311](https://github.com/cy2311)**、**[@LING71671](https://github.com/LING71671)**、**[@axobase001](https://github.com/axobase001)**、**[@dzyuan](https://github.com/dzyuan)**、**[@mvanhorn](https://github.com/mvanhorn)**、**[@malsony](https://github.com/malsony)**、**[@gaord](https://github.com/gaord)**、**[@yuanchenglu](https://github.com/yuanchenglu)**、**[@idling11](https://github.com/idling11)**、**[@h3c-hexin](https://github.com/h3c-hexin)**、**[@AdityaVG13](https://github.com/AdityaVG13)**、**[@Sskift](https://github.com/Sskift)**、**[@cyq1017](https://github.com/cyq1017)**、**[@HUQIANTAO](https://github.com/HUQIANTAO)**、**[@New2Niu](https://github.com/New2Niu)**、**[@AiurArtanis](https://github.com/AiurArtanis)**、**[@Lee-take](https://github.com/Lee-take)**、**[@nightt5879](https://github.com/nightt5879)**、**[@AresNing](https://github.com/AresNing)**、**[@AccMoment](https://github.com/AccMoment)**、**[@reidliu41](https://github.com/reidliu41)**、**[@aboimpinto](https://github.com/aboimpinto)**、**[@zhuangbiaowei](https://github.com/zhuangbiaowei)**、**[@donglovejava](https://github.com/donglovejava)**、**[@hongqitai](https://github.com/hongqitai)**、**[@zlh124](https://github.com/zlh124)**、**[@encyc](https://github.com/encyc)**、**[@Implementist](https://github.com/Implementist)**、**[@lihuan215](https://github.com/lihuan215)**、**[@LeoAlex0](https://github.com/LeoAlex0)**、**[@jimmyzhuu](https://github.com/jimmyzhuu)**、**[@rockyzhang](https://github.com/rockyzhang)**、**[@mo-vic](https://github.com/mo-vic)**、**[@hufanexplore](https://github.com/hufanexplore)**、**[@hoclaptrinh33](https://github.com/hoclaptrinh33)** 和 **[@BryonGo](https://github.com/BryonGo)**。 + +同样感谢提供报告、复现和验证的 **[@buko](https://github.com/buko)**、**[@yyyCode](https://github.com/yyyCode)**、**[@gaslebinh-glitch](https://github.com/gaslebinh-glitch)**、**[@Dr3259](https://github.com/Dr3259)**、**[@lpeng1711694086-lang](https://github.com/lpeng1711694086-lang)**、**[@VerrPower](https://github.com/VerrPower)**、**[@yan-zay](https://github.com/yan-zay)**、**[@jretz](https://github.com/jretz)**、**[@Neo-millunnium](https://github.com/Neo-millunnium)**、**[@caeserchen](https://github.com/caeserchen)**、**[@T-Phuong-Nguyen](https://github.com/T-Phuong-Nguyen)**、**[@zhyuzhyu](https://github.com/zhyuzhyu)**、**[@0gl20shk0sbt36](https://github.com/0gl20shk0sbt36)**、**[@hatakes](https://github.com/hatakes)**、**[@goodvecn-dev](https://github.com/goodvecn-dev)**、**[@bevis-wong](https://github.com/bevis-wong)**、**[@PurplePulse](https://github.com/PurplePulse)** 和 **[@nbiish](https://github.com/nbiish)**。 + - **[merchloubna70-dot](https://github.com/merchloubna70-dot)** — 28 个 PR，涵盖功能、修复和 VS Code 扩展基础架构 (#645–#681) - **[WyxBUPT-22](https://github.com/WyxBUPT-22)** — Markdown 表格、粗体/斜体和水平线渲染 (#579) - **[loongmiaow-pixel](https://github.com/loongmiaow-pixel)** — Windows + 中国安装文档 (#578) diff --git a/crates/tui/CHANGELOG.md b/crates/tui/CHANGELOG.md index 1b883941..b3532192 100644 --- a/crates/tui/CHANGELOG.md +++ b/crates/tui/CHANGELOG.md @@ -112,6 +112,14 @@ Thanks to contributors whose PRs landed or were harvested in this release: **@hoclaptrinh33** (#2358), and **@BryonGo** (#2437). +Thanks also to reporters and verification helpers whose issues, patches, +screenshots, logs, or retest requests shaped this release: **@buko** (#2359, +#2360, #2369, #2469), **@yyyCode**, **@gaslebinh-glitch**, **@Dr3259**, +**@lpeng1711694086-lang**, **@VerrPower**, **@yan-zay**, **@jretz**, +**@Neo-millunnium**, **@caeserchen**, **@T-Phuong-Nguyen**, **@zhyuzhyu**, +**@0gl20shk0sbt36**, **@hatakes**, **@goodvecn-dev**, **@bevis-wong**, +**@PurplePulse**, and **@nbiish**. + ## [0.8.47] - 2026-05-26 ### Added diff --git a/docs/RELEASE_CHECKLIST.md b/docs/RELEASE_CHECKLIST.md index 589fb3c2..277f9028 100644 --- a/docs/RELEASE_CHECKLIST.md +++ b/docs/RELEASE_CHECKLIST.md @@ -10,14 +10,17 @@ publish-crates), see [`RELEASE_RUNBOOK.md`](RELEASE_RUNBOOK.md). ## 1. CHANGELOG entry exists for the version - [ ] `CHANGELOG.md` has a `## [X.Y.Z] - YYYY-MM-DD` heading at the top -- [ ] The entry credits every external contributor whose commit lands in this - version. Get the list with: +- [ ] The entry credits every external contributor, harvested PR author, + linked issue reporter, reproduction/log provider, reviewer, and + verification helper whose work materially shaped this version. Get the + commit list with: ``` git log vPREV..HEAD --no-merges --format="%h %an <%ae> %s" \ | grep -v '' ``` For each contributor, link both their display name and (when known) - `@github-handle`. + `@github-handle`. Then inspect linked issues and harvested PRs so + reporters/helpers are not lost just because they did not author commits. - [ ] The entry uses the Keep a Changelog headers — `Added`, `Changed`, `Fixed`, `Security`, `Removed`, `Deprecated`. Add `Known issues` only if there is something material the user must work around. @@ -84,6 +87,12 @@ Run, in order, from the repo root: - [ ] `git push origin vX.Y.Z` - [ ] The `release.yml` workflow has built and uploaded artifacts to the GitHub release for this tag. +- [ ] The live GitHub Release body has its own `## Contributors` or + `## Credits` section; do not rely on "see CHANGELOG" alone. Verify with: + ``` + gh release view vX.Y.Z --repo Hmbown/CodeWhale --json body \ + --jq '.body | test("## (Contributors|Credits)")' + ``` - [ ] `npm view codewhale@X.Y.Z version codewhaleBinaryVersion --json` reports the new version on the npm registry. - [ ] `crates.io` has the new version (or the `publish-crates.sh` job has @@ -94,6 +103,8 @@ Run, in order, from the repo root: - [ ] Edit the GitHub release notes to expand any CVE-style or attack details that were intentionally omitted from the PR title/body. +- [ ] Re-run the GitHub Release body check after any release-workflow rerun; + workflows can overwrite notes and accidentally remove contributor credit. - [ ] Note any deferred items in the next release's tracking issue. - [ ] Close any issues that this release fixed. diff --git a/web/app/[locale]/faq/page.tsx b/web/app/[locale]/faq/page.tsx index f216552a..0e3d9167 100644 --- a/web/app/[locale]/faq/page.tsx +++ b/web/app/[locale]/faq/page.tsx @@ -39,6 +39,7 @@ npm install -g codewhale # Cargo (needs Rust 1.88+) cargo install codewhale-cli --locked +cargo install codewhale-tui --locked # Homebrew (macOS) brew tap Hmbown/deepseek-tui && brew install deepseek-tui @@ -47,7 +48,7 @@ brew tap Hmbown/deepseek-tui && brew install deepseek-tui # https://github.com/Hmbown/CodeWhale/releases`}

- Run codewhale to start. First run creates ~/.deepseek/ automatically. + Run codewhale to start. First run creates ~/.codewhale/ automatically. Legacy ~/.deepseek/ is still read as a compatibility fallback. See the full install guide for China mirrors, Docker, and troubleshooting.

@@ -72,7 +73,7 @@ brew tap Hmbown/deepseek-tui && brew install deepseek-tui <> Yes. CodeWhale is the new name for what was previously called DeepSeek TUI. The canonical command is now codewhale. Legacy deepseek and deepseek-tui commands remain as compatibility shims — they still work. - Config lives at ~/.deepseek/. DEEPSEEK_* env vars continue to work. + Config lives at ~/.codewhale/. Legacy ~/.deepseek/ config is still read as a compatibility fallback, and DEEPSEEK_* env vars continue to work. DeepSeek is not deprecated. The rename reflects CodeWhale's broader mission as the agentic terminal for open models across providers, not a narrowing away from DeepSeek. ), @@ -90,7 +91,7 @@ export DEEPSEEK_API_KEY=sk-... codewhale auth set --provider deepseek --api-key sk-... # Method 3: config.toml -# Add to ~/.deepseek/config.toml: +# Add to ~/.codewhale/config.toml: api_key = "sk-..." # Check what's active: @@ -113,11 +114,11 @@ codewhale doctor # full connectivity check`}

- Set the corresponding env var (e.g. OPENROUTER_API_KEY) and your provider in ~/.deepseek/config.toml. - Hugging Face, ZenMux, and self-hosted OpenAI-compatible endpoints are on the roadmap. + Set the corresponding env var (e.g. OPENROUTER_API_KEY) and your provider in ~/.codewhale/config.toml. + Self-hosted OpenAI-compatible endpoints are supported through the provider config.

), @@ -131,7 +132,7 @@ codewhale doctor # full connectivity check`} {`# 1. Set your OpenRouter key export OPENROUTER_API_KEY=sk-or-v1-... -# 2. In ~/.deepseek/config.toml: +# 2. In ~/.codewhale/config.toml: [providers.openrouter] api_key = "sk-or-v1-..." @@ -213,7 +214,7 @@ default_text_model = "openrouter/deepseek/deepseek-v4-pro"`} CodeWhale runs entirely on your machine. No telemetry, no cloud processing of your code. Sandbox backends: seatbelt (macOS), landlock (Linux), restricted tokens (Windows). Workspace boundaries default to --workspace. /trust lifts them. - Approval mode is configurable per session. All credential/approval/elevation events are written to ~/.deepseek/audit.log. + Approval mode is configurable per session. All credential/approval/elevation events are written to ~/.codewhale/audit.log. ), sources: ["SECURITY.md", "docs/ARCHITECTURE.md"], @@ -222,7 +223,7 @@ default_text_model = "openrouter/deepseek/deepseek-v4-pro"`} q: "How do MCP servers work?", a: ( <> - CodeWhale is a bidirectional MCP client and server. Define servers in ~/.deepseek/mcp.json. + CodeWhale is a bidirectional MCP client and server. Define servers in ~/.codewhale/mcp.json. Tools appear as mcp_<server>_<tool>. You can also expose CodeWhale as an MCP server with codewhale mcp. See the docs page for configuration examples. @@ -269,7 +270,7 @@ registry = "sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/"`} q: "My API key was rejected or I get auth errors on first run.", a: ( <> -

Run codewhale doctor — it checks API key, network, sandbox, and MCP servers. Full report is written to ~/.deepseek/doctor.log.

+

Run codewhale doctor — it checks API key, network, sandbox, and MCP servers. Full report is written to ~/.codewhale/doctor.log.

Common causes: