Skip to content

docs: document CNB provider and teamai session save#217

Merged
jeff-r2026 merged 1 commit into
Tencent:mainfrom
Eyre921:docs/cnb-session-provider
Jul 22, 2026
Merged

docs: document CNB provider and teamai session save#217
jeff-r2026 merged 1 commit into
Tencent:mainfrom
Eyre921:docs/cnb-session-provider

Conversation

@Eyre921

@Eyre921 Eyre921 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up documentation pass for two features that shipped without doc coverage:

Docs-only; no code changes. Bilingual docs kept in sync per the repo convention.

Changes

docs/providers.md (the provider reference — the main gap; it still said "当前实现了两个")

  • Provider count 两个 → 三个; added a cnb row to the table and to the auto-detection block.
  • New ## CNB Provider(cnb.cool) section: auth (cnb login OAuth2 device flow / CNB_TOKEN for CI), operations delegated to @cnbcool/cnb-cli, nested org/subgroup/repo paths, no default email domain, and the cnb.cool-only scope — with the TEAMAI_CNB_HOST + CNB_API_ENDPOINT note for self-hosted instances (feasible but untested, so not a supported config).
  • Manual-provider example now lists provider: cnb.

README.md / README.zh-CN.md

  • Git-host list "GitHub or TGit" → "GitHub, TGit, or CNB".

docs/usage-guide.md / docs/usage-guide.zh-CN.md

  • Create-repo step and prerequisites now mention CNB (and the auto-installed cnb CLI).
  • New Session Save section for teamai session save: --push / --force / --include-prompt, the local ~/.teamai/session-logs/<month>.md path, 90-day retention, the "valuable" heuristic, how --push feeds digest's Session Highlights, and the counts-only privacy posture.

Test Plan

  • npm run build
  • Verified the documented CLI surface matches the build: teamai session save --help shows --session-id / --push / --force / --include-prompt; the cnb.cool host mapping is present in dist/.
  • Grep confirms no stale "实现了两个" remains; CNB now referenced across README + usage-guide + providers.md.
  • Bilingual pairs edited together (README, usage-guide).

Follow-up doc pass for Tencent#208 (CNB provider) and Tencent#192 (session save), which
shipped without doc coverage.

- docs/providers.md: provider count 两个 → 三个; add `cnb` to the table and the
  auto-detection block; new "CNB Provider(cnb.cool)" section — auth via
  `cnb login` / `CNB_TOKEN`, operations delegated to @cnbcool/cnb-cli, nested
  paths, and the cnb.cool-only scope + TEAMAI_CNB_HOST/CNB_API_ENDPOINT note.
- README.md / README.zh-CN.md: add CNB to the git-host list.
- docs/usage-guide.md / .zh-CN.md: add CNB to the create-repo step and
  prerequisites; new "Session Save" section for `teamai session save`
  (--push / --force / --include-prompt, local ~/.teamai/session-logs path,
  90-day retention, "valuable" heuristic, digest Session Highlights, privacy).

Docs-only, bilingual kept in sync. Built and verified the documented surface:
`session save --help` shows the flags; the cnb.cool host mapping is in the build.
@jeff-r2026
jeff-r2026 merged commit 9810051 into Tencent:main Jul 22, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants