Skip to content

docs(onboarding): 将 WorkBuddy 列为受支持的 Agent Skill - #178

Open
Teamirni wants to merge 2 commits into
tt-a1i:mainfrom
Teamirni:workbuddy-agent
Open

docs(onboarding): 将 WorkBuddy 列为受支持的 Agent Skill#178
Teamirni wants to merge 2 commits into
tt-a1i:mainfrom
Teamirni:workbuddy-agent

Conversation

@Teamirni

Copy link
Copy Markdown

Problem
Archify 官方列出的受支持 Agent 为 Cursor、Claude Code、Codex CLI、OpenCode(中文 README 另含 Raven)。WorkBuddy 可以运行该 Skill(复制 archify/ 目录到 ~/.workbuddy/skills/archify 即可),但 README、落地页与 Start 页均未将其列为受支持 Agent,WorkBuddy 用户找不到对应的安装说明。

Solution
参照 Raven 的手动安装思路,为 WorkBuddy 补充「手动复制安装」说明,不新增 Agent 切换器命令或标签页,保持「同一份 Skill、零依赖渲染器」的交付一致性;同时同步更新三语 README、落地页 meta 描述与对应断言测试。

Changes

  • README.md / README_EN.md / README_ZH.md:受支持 Agent 列表新增 WorkBuddy
  • docs/index.html:落地页 meta description 新增 WorkBuddy
  • docs/start.html + scripts/start-template.html:新增 WorkBuddy 手动复制安装的中英双语说明
  • archify/test/cursor-onboarding.test.mjs、archify/test/landing.test.mjs:同步更新文案断言

Testing

  • 相关断言位于 archify/test/cursor-onboarding.test.mjs 与 archify/test/landing.test.mjs
  • 验证命令:cd archify && npm test(CI 覆盖 Node 18/20/22/24)
  • 覆盖场景:英/中 README 文案同步、落地页 meta 描述、Start 页切换器仍只含 4 个标准 Agent、WorkBuddy 说明存在

Notes for Reviewer

  • WorkBuddy 与 Raven 一样采用手动安装,有意不加入 agent-switcher 命令与 data-agent 标签页
  • docs/start.html 由 scripts/start-template.html 生成,两处已同步修改
  • archify.zip 无需重建(未触及 archify/ 运行时内容)
  • 注意:上游 README 已移除 Raven(仅中文版保留),本 PR 只新增 WorkBuddy、不重新引入 Raven

@tt-a1i tt-a1i left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this integration. The scope is appropriately narrow, and the proposed manual-install model is reasonable: Tencent documentation identifies .workbuddy/skills/ as WorkBuddy's Skill directory, while this PR keeps WorkBuddy out of the generated agent switcher and reuses the existing portable Skill.

I verified the following at this exact head:

  • the branch is current with main;
  • git diff --check passes;
  • the two targeted test files pass (6/6);
  • docs/start.html is reproducible from scripts/start-template.html;
  • the full local suite completes with 720 passed and 30 environment-gated skips.

However, listing a platform as supported is a stronger claim than showing that its documented directory convention is compatible. I need the following evidence and contract coverage before this can merge:

  1. Add a real WorkBuddy installation and invocation receipt. Please install the complete archify/ directory into a fresh or clearly identified WorkBuddy environment using the exact documented path, reload/restart WorkBuddy, show that archify is discovered, and invoke it to produce and validate at least one minimal diagram. Record the WorkBuddy version, OS, installed path, prompt/command, and Archify success receipt. The check must not resolve files or dependencies from the repository checkout.

  2. Make the tests cover the contract introduced by this PR. The current cursor-onboarding.test.mjs checks that the READMEs and landing metadata mention WorkBuddy, but it never asserts that either Start surface contains the WorkBuddy instructions or the exact ~/.workbuddy/skills/archify destination. It also checks that the four existing buttons exist, but does not prove that data-agent="workbuddy" is absent or that the switcher remains exactly four agents. Please add assertions for these behaviors on both the canonical template and generated page. As written, the new WorkBuddy paragraph could be removed or the switcher boundary could regress while the claimed coverage still passes.

  3. Run the repository-required CI on the resulting exact head. This PR currently has zero attached checks. Local tests are useful evidence, but they do not replace the protected Node/package lanes or any environment-gated checks.

No archify.zip rebuild is needed for this diff because the packaged runtime is unchanged. Once the real WorkBuddy receipt, exact contract tests, and required green CI are attached to the same head, this should be straightforward to re-review.

Tearimi added 2 commits August 30, 2026 14:17
Mirrors the Raven path: WorkBuddy is installed by copying archify/ into
~/.workbuddy/skills/archify, so it is documented in README, the start
page, and the landing meta description, but is intentionally not added as
a generated agent-switcher command or a data-agent tab.

Updates the bilingual onboarding assertions to match the new agent list.
…boundary

The previous change documented WorkBuddy on the Start surface, but nothing
asserted that documentation: the bilingual WorkBuddy paragraph and the exact
~/.workbuddy/skills/archify destination could be deleted, or the switcher could
grow a fifth agent, without any test failing.

Adds assertions that run against both the canonical template and the checked-in
generated page:

- the WorkBuddy manual-install instruction stays present in English and Chinese
- ~/.workbuddy/skills/archify appears in the English copy, the Chinese copy, and
  the visible text
- WorkBuddy never appears as data-agent="workbuddy" and the switcher stays
  exactly four agents, both as tabs and in KNOWN_AGENTS
- no surface claims a generated --agent workbuddy command, so listing WorkBuddy
  does not overstate what the agent switcher supports

Verified by mutation: deleting the paragraph, adding a WorkBuddy tab, appending
to KNOWN_AGENTS, and claiming a switcher command each turn the suite red.
@Teamirni

Teamirni commented Aug 30, 2026

Copy link
Copy Markdown
Author

Thanks for the detailed review. All three points are addressed on the new head \e3d3687.

1. Real WorkBuddy installation & invocation receipt

  • WorkBuddy version: 37.10.3-24 (from the installed app's version file)
  • OS: Windows 11 ????? (NT 10.0.22000)
  • Installed path: %USERPROFILE%\.workbuddy\skills\archify\ - the exact documented ~/.workbuddy/skills/archify\ destination. This is WorkBuddy's real skills root in the same home that holds WorkBuddy's bundled runtime (.workbuddy\binaries\node\versions\22.22.2-2\node.exe, v22.22.2); the skill is listed there alongside the other installed skills. A second copy was placed at a clean home (\�rchify-receipt-home/.workbuddy/skills/archify) to confirm the copy-install flow works outside any repository checkout.
  • Sanity check (from the installed path, not the checkout):
    ode bin/archify.mjs doctor\ ? 15/15 ok, \Archify is ready.\
  • Invocation:
    ode C:\Users\86147\.workbuddy\skills\archify\bin\archify.mjs deliver architecture minimal-proof.architecture.json minimal-proof-20260830.html --json\
  • Success receipt:
    \\json
    {
    "schemaVersion": 1,
    "ok": true,
    "command": "deliver",
    "type": "architecture",
    "input": "C:\Users\86147\archify-receipt-home\minimal-proof.architecture.json",
    "output": "C:\Users\86147\archify-receipt-home\minimal-proof-20260830.html",
    "specification": { "sha256": "3b32ca823f64328e4a877d54e82aa1e5fa96ce91ed5b33f9f8c3737c09c731f9", "bytes": 687 },
    "artifact": { "sha256": "fcc0ebcbed914f2e0d8941640ef1b7122f786aab77ff6bca9283875333048769", "bytes": 697772 },
    "validation": { "checksPassed": 9, "checkCount": 9, "compositionProfile": "standard", "compositionStatus": "pass", "errors": 0, "warnings": 0 }
    }
    \
    The check resolved no files or dependencies from the repository checkout - the CLI ran from the installed skill with WorkBuddy's own Node.

2. Contract coverage (commit e3d3687)

\cursor-onboarding.test.mjs\ now pins, on both \scripts/start-template.html\ and the checked-in \docs/start.html:

  • the bilingual WorkBuddy manual-install instruction stays present;
  • the exact ~/.workbuddy/skills/archify\ destination appears in the English copy, the Chinese copy, and the visible text;
  • \data-agent="workbuddy"\ never appears and the switcher stays exactly four agents - both as tabs and in \KNOWN_AGENTS;
  • no surface claims a generated --agent workbuddy\ command.

Mutation-verified: deleting the paragraph, adding a WorkBuddy tab, appending to \KNOWN_AGENTS, and claiming a switcher command each turn the suite red.

3. CI on the exact head

The branch was rebased onto current \main\ (\4ac500a, PR is mergeable) and force-pushed as \e3d3687. The \CI\ workflow run (id 33296592469) is queued on this head and awaiting approval for the fork PR - please approve so the Node 18/20/22/24 matrix, WebM/Chrome lanes, zip-freshness, and package smoke can attach to this head.

Local verification on this Windows host: the two targeted test files pass 6/7 - the only local failure is the \unzip-dependent archive test (no POSIX \unzip\ on Windows), which passes in the ubuntu CI lane. A full local suite run on the exact head (1009 tests: 949 pass, 27 fail, 33 skip) confines every remaining failure to Windows-environment-sensitive lanes - symlink creation (EPERM without Developer Mode), \unzip, Node \kill('SIGTERM')\ semantics (the \cli: preview . exits cleanly\ assertion fails identically on \main\ on this host), git filemode/index handling, and git-spawn tests when \git\ is absent from PATH. None of these are touched by this diff; the onboarding/contract tests added here pass.

@Teamirni

Teamirni commented Aug 30, 2026 via email

Copy link
Copy Markdown
Author

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