Repository navigation
fix(docs): publish OpenClaw and Hermes integration figures - #586
Conversation
|
Thanks for fixing the broken screenshots! I reviewed commit 0a7c391 and confirmed that all 14 documentation tests pass, the build succeeds, and every screenshot reference on the three affected pages resolves to a file in the build output. One small follow-up before merging: could you also add The image path rewrites and asset copying otherwise look good. Thank you! |
The figures this PR adds under integrations/hermes_agent/figures/ and integrations/openclaw/figures/ were not in either docs workflow's path filter, so a follow-up commit that only touches a PNG would skip the docs build and the broken-reference tests. Add both globs to the pull_request filter in ci-docs.yml and the push filter in deploy-docs.yml, matching how integrations/dsh/figures/** and reme_studio/figures/** are already listed. Requested in review on agentscope-ai#586.
|
Done in
placed next to the existing Both files still parse as workflow YAML and the filters verify as above. Note the push needed SSH: the Nothing else in the branch changed; the figures themselves are untouched from |
The generated /en/integrations/openclaw, /zh/integrations/openclaw and /en/integrations/hermes pages are built from the plugin READMEs, which reference local figures/. Only the dsh and Studio READMEs had their ./figures/ links rewritten to site paths and their figure directories copied into the build, so every screenshot on those three pages resolved to /<language>/integrations/figures/*.png and 404'd. verify-build.mjs only checks <a> links, never <img> sources, so the build stayed green. Mirror the dsh pattern: rewrite the figure links to /figures/openclaw/ and /figures/hermes/, copy both figure directories into public/figures/, add the missing language-cross link for the Hermes page, and cover all of it in the generated-content tests.
The figures this PR adds under integrations/hermes_agent/figures/ and integrations/openclaw/figures/ were not in either docs workflow's path filter, so a follow-up commit that only touches a PNG would skip the docs build and the broken-reference tests. Add both globs to the pull_request filter in ci-docs.yml and the push filter in deploy-docs.yml, matching how integrations/dsh/figures/** and reme_studio/figures/** are already listed. Requested in review on agentscope-ai#586.
f45a737 to
6a69680
Compare
|
Reviewed and tightened the regression coverage:
Validation on Node 22.22.2: all 14 documentation tests pass; the complete documentation build succeeds, including 38 build-artifact checks; pre-commit passes for the changed test file. The production changes follow the existing DSH/Studio publishing pattern, and I found no blocking correctness issues. I will merge once the latest required checks and repository review requirements are satisfied. |
jinliyl
left a comment
jinliyl
left a comment
There was a problem hiding this comment.
Reviewed the figure path rewrites, asset publishing, and workflow triggers. All local documentation tests, the complete build, and focused pre-commit checks pass. Regression coverage now validates every screenshot reference and both new workflow inputs. No blocking issues found.
2 participants
What
线上文档站（reme.agentscope.io）的三个集成页面所有截图都是坏的：
/en/integrations/openclaw/zh/integrations/openclaw/en/integrations/hermes这些页面由
generate-content.mjs从integrations/openclaw/README*.md和integrations/hermes_agent/README.md生成，README 里引用的是仓库内的figures/*.png（openclaw 7 张、hermes 5 张）。但生成器只对 dsh 和 Studio 的 README 做了(./figures/→(/figures/dsh/（/studio/）的重写，也只拷贝了这两个目录到public/figures/。于是这三个页面的图片地址解析成/<language>/integrations/figures/*.png，构建产物里没有这些文件——线上全部 404。verify-build.mjs只校验<a href>内部链接（第 124-135 行），从不检查<img src>，所以文档构建一直是绿的，问题只在线上暴露。Fix
完全复刻 dsh 的既有模式：
integrations/openclaw/README.md/README_ZH.md：(./figures/→(/figures/openclaw/integrations/hermes_agent/README.md：(figures/→(/figures/hermes/（该 README 的图片链接没有./前缀），并补上缺失的语言互链(README_ZH.md)→(/zh/integrations/hermes)integrations/openclaw/figures和integrations/hermes_agent/figures拷贝进public/figures/openclaw与public/figures/hermesgithub-pages/tests/generated-content.test.mjs增加与 Studio 截图测试同构的用例，同时断言链接重写和图片落盘Validation
not ok（1 failed），修复后14 passed，红→绿成立。npm test（github-pages）：14/14 通过。npm run build（github-pages，本机 Node 18.20.8 + vitepress 1.6.4）：构建成功，verify-build.mjs36 项全部通过。dist/：figures/openclaw/、figures/hermes/与既有figures/dsh/、figures/studio/并列存在；dist/en/integrations/openclaw.html的src="/figures/openclaw/status-overview.png"，dist/en/integrations/hermes.html的src="/figures/hermes/hermes-provider-settings.png"。verify-build.mjs：该清单按既有惯例只收录ecosystem/*，dsh/studio 的 figures 也未列入，新用例已覆盖生成期校验。