mirror of https://github.com/agentscope-ai/ReMe.git synced 2026-09-14 23:21:04 +00:00

History

jinliyl 1f67a6ce29 Some checks failed Security / CodeQL / Analyze javascript-typescript (push) Has been cancelled Details Deploy / Documentation / Build documentation (push) Has been cancelled Details CI / Documentation / Test and build documentation (push) Has been cancelled Details CI / Python packages / Build and verify distributions (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.11 (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.13 (push) Has been cancelled Details Security / CodeQL / Analyze python (push) Has been cancelled Details CI / Python quality / Pre-commit (push) Has been cancelled Details CI / Python tests / Unit Tests - py3.12 (push) Has been cancelled Details CI / Windows / CLI smoke - py3.11 (push) Has been cancelled Details Deploy / Documentation / deploy (push) Has been cancelled Details fix(docs): repair dark mode styling (#526 )		2026-09-07 17:33:36 +08:00
..
public	docs: add standalone GitHub Pages site (#448 )	2026-08-12 11:55:35 +08:00
scripts	feat(docs): redesign homepage and add traffic dashboard (#522 )	2026-09-05 00:53:32 +08:00
tests	fix(docs): repair dark mode styling (#526 )	2026-09-07 17:33:36 +08:00
.gitignore	docs: add standalone GitHub Pages site (#448 )	2026-08-12 11:55:35 +08:00
package-lock.json	docs: rebuild documentation site with VitePress (#518 )	2026-09-04 14:50:50 +08:00
package.json	docs: rebuild documentation site with VitePress (#518 )	2026-09-04 14:50:50 +08:00
README.md	docs: rebuild documentation site with VitePress (#518 )	2026-09-04 14:50:50 +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 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.

Sources

docs/: canonical guides, VitePress configuration, theme, and brand assets
reme/config/default.yaml: generated callable Job reference
reme_studio/README*.md: ReMe Studio
typescript/README*.md: TypeScript client and adapters
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.