4c54c2b650
Some checks failed
CI / Python packages / Build and verify distributions (push) Waiting to run
CI / Python quality / GitHub Actions (push) Waiting to run
CI / Python quality / Pre-commit (push) Waiting to run
CI / Python tests / Unit Tests - py3.11 (push) Waiting to run
CI / Python tests / Unit Tests - py3.12 (push) Waiting to run
CI / Python tests / Unit Tests - py3.13 (push) Waiting to run
CI / Python tests / Unit Tests - py3.14 (push) Waiting to run
CI / Windows / CLI smoke - py3.11 (push) Waiting to run
Deploy / Documentation / Build documentation (push) Waiting to run
Deploy / Documentation / deploy (push) Blocked by required conditions
CI and Release / Docker / Build and test / amd64 (push) Waiting to run
CI and Release / Docker / Build and test / arm64 (push) Waiting to run
CI and Release / Docker / Publish multi-platform tags (push) Blocked by required conditions
Security / CodeQL / Analyze javascript-typescript (push) Waiting to run
Security / CodeQL / Analyze python (push) Waiting to run
CI / ReMe Studio / Studio checks (push) Has been cancelled
* feat(docker): add container deployment and multi-platform release workflow * fix(llm): initialize providers on model access and preserve runtime injection * test(llm): keep rejected model updates independent of credentials |
||
|---|---|---|
| .. | ||
| public | ||
| scripts | ||
| tests | ||
| .gitignore | ||
| ecosystem-assets.md | ||
| package-lock.json | ||
| package.json | ||
| 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 assetsreme/config/default.yaml: generated callable Job referencereme_studio/README*.md: ReMe Studio documentationreme_studio/demo/: browser data adapter, bilingual Markdown examples, tags, and scripted conversationsintegrations/{dsh,openclaw}/README*.md: TypeScript host pluginsplugins/*/README*.md: plugin guidesbenchmark/*/README*.md: benchmark guidesscripts/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.