Skip to content

ChatNote Docs

ChatNote is a ChatArch Python package for note tooling. The current package provides only a standard skeleton, version, help, and the registered CLI tree. Note creation, storage, search, and synchronization are not implemented. Use the CLI tree, capability map, and Python interface tree to inspect its current boundaries.

Site entry: https://arch.gh.wzhecnu.cn/ChatNote/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

Documentation is organized around the current interfaces:

  • 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.

Local Preview

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

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