AgentScope Documentation

August 4, 2026 · View on GitHub

This repository is the source for the unified AgentScope documentation site. It publishes English and Chinese documentation for AgentScope and ReMe with Mintlify.

Documentation Sets

The two projects share one site but keep separate content and release models:

Project	Documentation scope	Live documentation	Update model
AgentScope	Building, operating, and deploying agent applications	AgentScope docs	Immutable version directories
ReMe	File-native agent memory, workflows, integrations, and stable contracts	ReMe docs	One continuously updated `latest` version

The ReMe repository README is the concise project entry point. This repository owns the complete public documentation: concepts, verified workflows, integrations, reference material, troubleshooting, and contribution guidance.

ReMe documentation should preserve the product principles expressed by its README:

memory files are user-owned source data;
indexes, graphs, and caches are rebuildable derived state;
conversations and resources become correctable, traceable Markdown memory;
Python, AgentScope, MCP, CLI, HTTP, plugins, and Skills are integration boundaries over the same file-native memory model.

The current ReMe content is organized by user goal:

Area	Pages	Purpose
Get Started	Overview, Quick Start, Concepts	Explain the product, complete the first memory loop, and establish its principles
Integration	Integration overview, Deployment, Python SDK, Plugins	Choose and implement the correct runtime boundary
Resources	Reference, FAQ, Contribution	Find stable contracts, solve common problems, and contribute changes

Chinese pages mirror the same structure under reme/latest/zh/. Update both languages together and keep their intent, headings, examples, and links aligned.

Local Development

Use an active Node.js LTS release (Node 20 or 22).

Install the Mintlify CLI:

npm i -g mint

From the repository root, validate the site or start a preview:

mint validate
mint dev

The preview is available at http://localhost:3000 by default.

Repository Structure

.
├── versions/
│   └── <version>/{en,zh}/   # Versioned AgentScope documentation
├── reme/
│   └── latest/{en,zh}/      # Current ReMe documentation
├── images/                  # Shared static assets
├── scripts/                 # Documentation maintenance scripts
├── docs.json                # Mintlify navigation and redirects
└── CLAUDE.md                # Writing and review guidelines

Content Boundaries

Keep public documentation focused on user goals and stable behavior:

Verify ReMe behavior against current code, public schemas, tests, CLI help, and reme/config/default.yaml.
Explain the stable contract and link to authoritative source instead of duplicating implementation details.
Keep concepts focused on product intent; place detailed development mechanics in source code, tests, and repository-local guidance.
Lead with the outcome, use direct language, and introduce every table, image, diagram, and code block.
Start each MDX page with title and description frontmatter.

See CLAUDE.md for the complete writing and component guidelines.

Version Management

AgentScope documentation is immutable within each published version directory. For a new AgentScope release:

Copy the latest relevant version into a new project version directory.
Update every version-specific internal link in the copied pages.
Add the version under the matching project tab for both languages in docs.json.
Point the relevant latest or stable redirect at the new version.
Run mint validate before submitting the change.

AgentScope versions can be created with scripts/create-version.sh.

ReMe does not keep historical release directories. Update reme/latest/{en,zh}/ directly, keep canonical internal links under /reme/latest/..., and leave its docs.json version label as latest. The /reme/stable/... alias and obsolete numeric-version URLs redirect to the current pages for compatibility.

Contribution Workflow

When adding or updating documentation:

Verify the behavior in the corresponding project source.
Update the correct project, version, and language pages.
For ReMe, make the equivalent English and Chinese changes in reme/latest/.
Update docs.json when navigation, versions, or compatibility redirects change.
Check page links and run mint validate before submitting a pull request.

Run these checks from the repository root before submitting:

git diff --check
mint validate