channels Documentation

1. Project Overview & Quickstart (agentscope-ai/channels) Copy Chapter

channels

Developer-friendly asynchrony for Django

Repository Details Copy Section

• Repository: agentscope-ai/channels
• GitHub Stars: ⭐ 6,348
• Primary Language: Python

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (agentscope-ai/docs) Copy Chapter

File: README.md Copy Chapter

AgentScope Documentation

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 Copy Chapter

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

ReMe Documentation Copy Chapter

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:

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 Copy Chapter

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

Install the Mintlify CLI:

npm i 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 Copy Chapter

.
├── 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 Copy Chapter

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 Copy Chapter

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

1. Copy the latest relevant version into a new project version directory.
2. Update every version-specific internal link in the copied pages.
3. Add the version under the matching project tab for both languages in docs.json.
4. Point the relevant latest or stable redirect at the new version.
5. 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 Copy Chapter

When adding or updating documentation:

1. Verify the behavior in the corresponding project source.
2. Update the correct project, version, and language pages.
3. For ReMe, make the equivalent English and Chinese changes in reme/latest/.
4. Update docs.json when navigation, versions, or compatibility redirects change.
5. 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

Resources Copy Chapter

• AgentScope GitHub
• ReMe GitHub
• ReMe English documentation
• ReMe 中文文档
• Mintlify Documentation

File: reme/README.md Copy Chapter

ReMe documentation

ReMe documentation is part of the unified Mintlify site in this repository.

• latest/ contains the current en/ and zh/ MDX pages and is updated in place.
• ReMe does not maintain numbered or historical documentation directories.
• Shared ReMe media lives in images/reme/.
• Navigation is defined by the ReMe tab for each language in docs.json.
• Canonical internal links use /reme/latest/...; compatibility redirects preserve old URLs.

Keep the documentation focused on product philosophy, verified user workflows, and stable contracts. Implementation details belong in the ReMe source, schemas, tests, and runtime help.