fd2894f939
Some checks failed
NPM Format / Website checks (push) Has been cancelled
GitHub Pages Check / test-and-build (push) Has been cancelled
Package Check / distributions (push) Has been cancelled
Deploy ReMe documentation / build (push) Has been cancelled
Windows Smoke / CLI smoke - py3.11 (push) Has been cancelled
Pre-commit / run (ubuntu-latest) (push) Has been cancelled
Tests ReMe / Unit Tests - py3.11 (push) Has been cancelled
Tests ReMe / Unit Tests - py3.12 (push) Has been cancelled
Tests ReMe / Unit Tests - py3.13 (push) Has been cancelled
Deploy ReMe documentation / deploy (push) Has been cancelled
* fix(packaging): harden the Studio release workflow * chore(daily-paper): tune scheduled discovery defaults * fix(docs): link the ReMe blog to GitHub Pages * fix(docs): increase Chinese hero title spacing * refactor(docs): share hero title line spacing * fix(docs): keep desktop hero copy on two lines * fix(docs): widen the home hero description * style(docs): loosen hero title line height * fix(docs): hide Markdown frontmatter in rendered pages * docs(readme): simplify installation and remove standalone ReMe Studio instructions - Remove references to separate ReMe Studio package and static build steps - Clarify that `core` extra includes common integrations including Studio - Update installation instructions to use `pip install -e ".[core]"` - Remove detailed Studio usage and frontend development instructions - Note that Studio is included with `core` and optional via `web` extra - Simplify Quick Start guide by removing Studio usage step - Remove mentions of serving Studio with HTTP service when using extras - Update both English and Chinese README files accordingly * docs(readme): streamline and clarify memory design and operations - Remove redundant explanations about core extra installation - Simplify memory processing flow description for clarity - Clarify memory workspace directory default and customization - Condense automatic memory flow to emphasize rebuildable metadata - Refine search functionality explanation with RRF fusion details - Shorten and clarify agent integration description, removing redundancy - Update and simplify the operations command list, removing less common commands - Revise community and support section for conciseness and clarity - Maintain parallel updates in both English and Chinese README files * test(bump_version): add tests for version bumping and consistency checks - Add dynamic loading of bump_version and package_studio scripts for testing - Test that studio package and dependencies have matching versions - Implement fixtures to write temporary version files for testing - Add test ensuring bump_version updates all relevant files and dependencies - Add test to reject inconsistent version sources before writing - Refactor tests to use common REPOSITORY path variable - Include imports and setup for pytest in test file feat(bump_version): create script to update ReMe and Studio versions - Implement version reading from __init__.py and pyproject.toml files - Validate current versions are consistent across files before updating - Update version strings atomically to avoid partial writes - Ensure exact pinning of studio dependency in main package extras - Validate new version format against a safe pattern - Provide CLI interface to bump versions from command line - Raise errors if expected version declarations or pins are missing or duplicated * fix(release): validate split package publishing * fix(release): improve validation diagnostics * fix(release): sync docs and workflow inputs * fix(release): split PyPI publish jobs |
||
|---|---|---|
| .. | ||
| public | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| index.html | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| vite.config.js | ||
ReMe GitHub Pages
This directory contains the standalone Vite documentation site published at https://reme.agentscope.io. The
GitHub Pages fallback is https://agentscope-ai.github.io/ReMe/. It does not depend on the ReMe Studio application in
website/.
Requirements
- Node.js 22.13 or newer
- npm
Local development
From the repository root:
cd github-pages
npm install
npm run dev
Open the URL printed by Vite, normally http://localhost:5173/. The development server watches the frontend source. When a repository Markdown file changes, restart the development command to regenerate the documentation content.
For subsequent installs or CI-compatible dependency installation, use:
npm ci
Preview the production build
Build and start the preview server:
npm run build
npm run preview
Open the URL printed by Vite, normally http://localhost:4173/. Production assets use relative paths so the same build works on both the custom domain and the GitHub Pages project path.
The generated dist/ and .generated/ directories are disposable build output and are excluded from Git.
Documentation sources
The build script reads the canonical repository files directly. Do not edit generated copies under .generated/ or
dist/.
README.mdandREADME_ZH.md: project introductionsdocs/en/anddocs/zh/: English and Chinese guidesdocs/figure/: documentation imageswebsite/README.mdandwebsite/README_ZH.md: ReMe Studio guidecookbook/*/README*.md: research workflow guidesbenchmark/{beam,longmemeval,pibench,toolmemory}/README*.md: benchmark guides and resultsskills/reme_memory/SKILL.md: ReMe Memory skill guideAGENTS.md: repository development guide
To add or reorganize a document in the site navigation, update
scripts/generate-content.mjs. Presentation and interaction code lives in src/.
Project structure
github-pages/
├── index.html
├── package.json
├── scripts/
│ └── generate-content.mjs
├── src/
│ ├── main.js
│ └── styles.css
└── vite.config.js
Deployment
The repository workflow .github/workflows/pages.yml builds this directory and publishes dist/ to GitHub Pages.
It runs after relevant documentation or site files change on main, and it can also be started manually from the
GitHub Actions page.
The repository's Settings → Pages → Build and deployment → Source must be set to GitHub Actions. Its custom
domain must be set to reme.agentscope.io; public/CNAME preserves that domain in the published artifact.
Useful links:
- ReMe documentation: https://reme.agentscope.io
- GitHub Pages fallback: https://agentscope-ai.github.io/ReMe/
- ReMe repository: https://github.com/agentscope-ai/ReMe