mirror of https://github.com/agentscope-ai/ReMe.git synced 2026-10-13 04:01:35 +00:00

History

Ziyang Guo 084c02e43a Some checks failed CI / Python quality / GitHub Actions (push) Has been cancelled Details CI / Python quality / Pre-commit (push) Has been cancelled Details Security / CodeQL / Analyze javascript-typescript (push) Has been cancelled Details Security / CodeQL / Analyze python (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.11 (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.12 (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.13 (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.14 (push) Has been cancelled Details CI / Windows / CLI smoke - py3.11 (push) Has been cancelled Details Deploy / Documentation / Build documentation (push) Has been cancelled Details Deploy / Documentation / deploy (push) Has been cancelled Details fix(docs): publish OpenClaw and Hermes integration figures (#586 ) * fix(docs): publish OpenClaw and Hermes integration figures 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. ci(docs): watch the new integration figure directories 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 #586. * test(docs): validate all integration screenshot references --------- Co-authored-by: jinli.yl <jinli.yl@alibaba-inc.com>		2026-10-06 14:32:09 +08:00
..
public	docs: show ReMe ecosystem on homepage (#568 )	2026-09-24 11:58:05 +08:00
scripts	fix(docs): publish OpenClaw and Hermes integration figures (#586 )	2026-10-06 14:32:09 +08:00
tests	fix(docs): publish OpenClaw and Hermes integration figures (#586 )	2026-10-06 14:32:09 +08:00
.gitignore	docs: add standalone GitHub Pages site (#448 )	2026-08-12 11:55:35 +08:00
ecosystem-assets.md	docs: show ReMe ecosystem on homepage (#568 )	2026-09-24 11:58:05 +08:00
package-lock.json	docs: rebuild documentation site with VitePress (#518 )	2026-09-04 14:50:50 +08:00
package.json	feat(studio): add bilingual browser demo to documentation site (#581 )	2026-10-03 22:34:11 +08:00
README.md	feat(studio): add bilingual browser demo to documentation site (#581 )	2026-10-03 22:34:11 +08:00

README.md

ReMe documentation site

This package builds the VitePress site published at https://reme.agentscope.io. The canonical documentation lives in docs/; selected product, integration, plugin, and benchmark READMEs are mirrored into a disposable source tree during the build. Do not edit .generated/ or dist/.

Requirements

Node.js 22.13 or newer
npm

Local development

cd github-pages
npm ci
npm ci --prefix ../reme_studio
npm run dev

The development server prints its local URL. Restart it after changing a mirrored README or reme/config/default.yaml so the generated source tree and Job reference are refreshed. Changes under docs/ are also refreshed on restart.

Validation

npm test
npm run build
npm run preview

The test suite verifies bilingual core pages, canonical-source mappings, generated Job coverage, and disposable output. The production build is written to github-pages/dist/ for the existing GitHub Pages workflow. Development and build commands also compile the shared Studio UI in browser-demo mode and include it at /studio/; install both packages' dependencies before running them. The demo needs no ReMe service or model credentials.

Sources

docs/: canonical guides, VitePress configuration, theme, and brand assets
reme/config/default.yaml: generated callable Job reference
reme_studio/README*.md: ReMe Studio documentation
reme_studio/demo/: browser data adapter, bilingual Markdown examples, tags, and scripted conversations
integrations/{dsh,openclaw}/README*.md: TypeScript host plugins
plugins/*/README*.md: plugin guides
benchmark/*/README*.md: benchmark guides
scripts/generate-content.mjs: source mirroring and reference generation

When adding a canonical guide, add both docs/zh/<name>.md and docs/en/<name>.md, then include it in the appropriate sidebar in docs/.vitepress/config.mts. Add repository-owned READMEs to externalDocuments in the generator rather than duplicating their full content under docs/.

Deployment

.github/workflows/deploy-docs.yml uses the reusable documentation build workflow and publishes dist/ to GitHub Pages. public/CNAME preserves the reme.agentscope.io custom domain.