Skip to content

docs(cli): 补全 CLI 使用文档并统一入口名 + §8 旧位规则清理 - #193

Merged
ReSerendipity merged 2 commits into
mainfrom
docs/cli-usage-and-entry-rename
Oct 20, 2026
Merged

ReSerendipity merged 2 commits into
mainfrom
docs/cli-usage-and-entry-rename

Conversation

@ReSerendipity

Copy link
Copy Markdown
Owner

描述

docs/cli-usage-and-entry-rename 分支上有 2 个提交未进入 main:CLI 使用文档补全(入口名统一为 tts-multimodel)与 §8 README 双版本口径清理。分支当前检出、无 PR,本 PR 以 Draft 建档。

变更类型

  • 📝 文档更新
  • 🔧 构建/CI/依赖相关

变更内容

  • docs(cli):补全 CLI 使用文档,入口名统一为 tts-multimodel(README.md +58 行,app/integrated_app/cli.py 入口名对齐)
  • ch(structure):清理旧位 docs/README.internal.md 忽略规则并对齐 §8 双版本位置
    • docs/README.md(2026-08-27 内部文档块、未跟踪)→ local/README.internal.md
    • 同时满足「保持本地不入库 + §12.1 docs/ 纯入库 + §8 双版本完备」

当前状态

项 值
领先 / 落后 main +2 / 0
与 main 内容差异 3 文件(.gitignore、README.md、app/integrated_app/cli.py),+64 / -9
合并冲突 无(git merge-tree rc=0)
DCO 2 个提交全部已签署 ✅

建议的合入路径

  1. 重跑本地门禁(pre-push 的 mypy ratchet / REVISION_LOG ledger 已在本机通过);
  2. 转 Ready for review 并合并(无冲突)。

补充说明

2026-10-20 分支清点中,本分支的第二个提交(§8 清理)是当日对旧位忽略规则的修复;因该仓当时检出在本分支,修复随之落在分支而非 main,故一并提交 PR 归入主线。

- README 新增「命令行使用」章节:design/clone/batch 三个子命令与常用参数表
- cli.py:弃用警告与示例中的 voxcpm 统一改名为 tts-multimodel(与安装入口一致)

Signed-off-by: ReSerendipity <259081123+ReSerendipity@users.noreply.github.com>
- §8 双版本制度 2026-10-13 建立时对内版固定 local/README.internal.md,旧位规则成死规则
- 原 docs/README.md(2026-08-27 内部工作文档块,未跟踪)内容为文档索引/项目速览,
  迁至 local/README.internal.md 后同时满足:保持本地不入库 + docs/ 纯入库(§12.1)+ §8 双版本完备
- /local/ 忽略规则(.gitignore:391)已在位,覆盖新位置

Signed-off-by: ReSerendipity <259081123+ReSerendipity@users.noreply.github.com>
@ReSerendipity
ReSerendipity marked this pull request as ready for review October 20, 2026 03:50
@ReSerendipity
ReSerendipity merged commit fdb5c11 into main Oct 20, 2026
36 checks passed
@ReSerendipity
ReSerendipity deleted the docs/cli-usage-and-entry-rename branch October 20, 2026 04:45
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.

1 participant