Skip to content

ChatMail Docs

ChatMail is a ChatArch Python package. This documentation site should hold long-lived usage notes, a command map, a capability map, and Python interface entry points. After scaffolding, replace placeholders with behavior that is actually implemented, explored, or planned for this package.

Site entry: https://arch.gh.wzhecnu.cn/ChatMail/en/

Choose Documentation by Scenario

Scenario Document
Install the package, run the CLI, and confirm it works CLI Tree
Check first-class capabilities and current boundaries Capability Map
Call package behavior directly from Python Python Interface Tree

Documentation Organization

This template keeps only durable documentation entry points; it does not generate a plan placeholder:

  • CLI tree: the most direct command entry point, including the real command tree, status, and update checklist.
  • Capability map: first-class capabilities, boundaries, and out-of-scope areas.
  • Interface tree: importable Python APIs behind the CLI.

Primary Entry Points

  • CLI Tree

    Start from the CLI entry point and record implemented commands, command status, and interactive conventions.

    Open CLI Tree

  • Capability Map

    Review current package boundaries and avoid presenting planned work as implemented behavior.

    Open Capability Map

  • Python Interface Tree

    Keep the CLI thin and put substantive behavior in importable Python APIs.

    Open Interface Tree

Documentation Status

  • Implemented: code, tests, or CLI routes exist.
  • Verified: covered by local smoke, CI, or real-service practice.
  • Not implemented: keep as boundary and planning notes only; turn into operation docs after implementation and validation.

CLI Contract

chatmail --version
chatmail --tree
chatmail --tree-brief

The full tree includes parameter signatures. The brief tree preserves the same registered nodes and descriptions without signatures.

Local Preview

python -m pip install -e ".[docs]"
mkdocs serve

The Chinese home page is available at https://arch.gh.wzhecnu.cn/ChatMail/. Topic pages without English translations fall back to the default Chinese content through the i18n plugin.