749c653f23
* feat(integrations): add native Claude Code and Codex memory plugins * docs(integrations): make plugin installation the coding agent entry point * feat(integrations): configure plugin connections from user settings * refactor(codex): use MCP tools and native plugin settings * fix(codex): restore plugin hooks on current runtimes * docs(codex): expand setup guide and reserve screenshot slots * feat(codex): add configurable memory consolidation and status * feat(codex): merge connection checks into a tabbed status app * docs(codex): diagnose blocked status panel sandbox loading * fix(codex): simplify status panel layout for narrow cards * docs(codex): focus guides on connecting and using ReMe * docs(codex): specify validated CLI and desktop version requirements * feat(codex): add ReMe branding to plugin icons * docs(codex): prepare manual screenshot workflow * fix(codex): simplify ReMe status layout and activity * docs(codex): explain Hook loading and local project context * fix(codex): keep status refresh clear of host close control * fix(codex): retain status resources for active MCP connections * docs(codex): add real desktop screenshots to usage guides * fix(integrations): address memory capture and consolidation review * fix(codex): preserve capture endpoint during background delivery |
||
|---|---|---|
| .. | ||
| 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.