Skip to content

Commit 15e97a5

Browse files
committed
Polish bilingual documentation for v0.1.1
1 parent 864090f commit 15e97a5

61 files changed

Lines changed: 1248 additions & 1084 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://json.schemastore.org/claude-code-plugin-manifest.json",
33
"name": "blender-vse",
44
"displayName": "Blender VSE Control",
5-
"version": "0.1.0",
5+
"version": "0.1.1",
66
"description": "Local, revision-safe control of editable Blender VSE projects with one Skill and a four-tool MCP server.",
77
"author": {
88
"name": "Aoike",

.codex-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "blender-vse",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Local, revision-safe control of editable Blender VSE projects through one Skill and four MCP tools.",
55
"author": {
66
"name": "Aoike",

CHANGELOG.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,36 @@
22

33
[Chinese version](CHANGELOG_zh-CN.md)
44

5+
## 0.1.1 - 2026-09-04
6+
7+
- Rewrote all 25 English/Chinese documentation pairs for clear, natural prose
8+
while preserving commands, contracts, and safety boundaries.
9+
- Standardized terminology for revisions, observation IDs, targeted reads,
10+
operation catalogs, allowlists, Agent hosts, and proxy media.
11+
- Fixed Markdown emphasis boundaries and added contract checks for emphasis,
12+
heading spacing, and fenced code blocks.
13+
- Replaced the English and Chinese social-preview taglines with concise,
14+
reader-friendly copy and regenerated the verified image assets.
15+
- Corrected documentation examples and claims for `set_text`, new project
16+
paths, the GUI smoke workflow, and persistence verification.
17+
518
## 0.1.0 - 2026-09-04
619

7-
- Repositioned the project around local, revision-safe agent editing of
8-
persistent `.blend` timelines, with bounded context as a supporting guarantee.
9-
- Expanded package and plugin discovery metadata for Blender VSE, AI video
10-
editing, MCP, NLE, agent Skills, revision safety, and local-first workflows.
11-
- Fixed the public GUI smoke workflow to pass the observed strip name required
12-
by `set_text` while retaining the stable strip ID for follow-up reads.
20+
- Reframed the project as a local, revision-safe agent editor for persistent
21+
`.blend` timelines, with bounded context as a supporting guarantee rather
22+
than the product category itself.
23+
- Expanded the package and plugin discovery metadata to cover Blender VSE, AI
24+
video editing, MCP, NLE, Agent Skills, revision safety, and local-first
25+
workflows.
26+
- Corrected the public GUI smoke workflow so `set_text` receives the observed
27+
strip name while follow-up reads continue to use the stable strip ID.
1328
- Added the missing distribution-content verification command to the release
1429
checklist.
15-
16-
- Standalone Blender VSE control package and CLI.
30+
- Added a standalone Blender VSE control package and CLI.
1731
- Revision-safe read, patch, acknowledge, and verify workflow.
18-
- Four-tool local MCP server with explicit project-root authorization.
19-
- Low-context Agent Skill with bounded reads and resume capsules.
32+
- A four-tool local MCP server with explicit project-root authorization.
33+
- A context-efficient Agent Skill with bounded reads and resume capsules.
2034
- Codex, Claude Code, and DSH installation paths.
21-
- uv-managed Python 3.12 runtime bootstrap; no system Python required for plugin users.
35+
- A `uv`-managed Python 3.12 runtime bootstrap; plugin users do not need a
36+
system Python installation.
2237
- Bilingual English and Chinese documentation.

CHANGELOG_zh-CN.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,26 @@
22

33
[English version](CHANGELOG.md)
44

5+
## 0.1.1 - 2026-09-04
6+
7+
- 重写全部 25 组中英文文档,使两种语言都自然、清晰,同时保留命令、契约和安全边界。
8+
- 统一修订、观察 ID、定向读取、操作目录、允许列表、Agent 宿主和代理媒体等术语。
9+
- 修复 Markdown 粗体边界,并新增粗体、标题间距和代码围栏的契约检查。
10+
- 采用更简洁、易读的中英文社交预览标语,并重新生成经过校验的图片资产。
11+
- 修正文档中关于 `set_text`、新项目路径、GUI 冒烟流程和持久化验证的示例与说明。
12+
513
## 0.1.0 - 2026-09-04
614

7-
- 统一定位为面向持久 `.blend` 时间线的本地、修订安全 Agent 剪辑;有界上下文作为
8-
支撑保证,不再作为产品类别本身
9-
- 扩展包与插件的发现关键词,覆盖 Blender VSE、AI 视频编辑、MCP、NLE、Agent Skill、
10-
修订安全与本地优先工作流
11-
- 修复公开 GUI 冒烟流程:`set_text` 使用已观察到的片段名,后续读取仍使用稳定片段 ID。
15+
- 将项目重新定位为面向持久 `.blend` 时间线、具备修订保护的本地 Agent 剪辑控制层;
16+
有界上下文是配套保证,而非产品类别本身
17+
- 扩充包和插件的检索元数据,覆盖 Blender VSE、AI 视频编辑、MCP、NLE、Agent Skill、
18+
修订保护和本地优先工作流
19+
- 修复公开 GUI 冒烟流程:`set_text` 传入观察到的片段名称,后续读取仍使用稳定片段 ID。
1220
- 在发布清单中补充缺失的分发内容校验命令。
13-
14-
- 独立 Blender VSE 控制包与 CLI。
21+
- 新增独立的 Blender VSE 控制包和 CLI。
1522
- 带修订保护的 read、patch、acknowledge 与 verify 工作流。
16-
- 具有显式项目根目录授权的四工具本地 MCP 服务。
17-
- 使用有界读取与恢复胶囊的低上下文 Agent Skill。
18-
- Codex、Claude Code DSH 安装路径
19-
- uv 管理的 Python 3.12 运行时;插件用户无需系统 Python。
20-
- 独立英文与中文文档
23+
- 提供明确项目根目录授权的四工具本地 MCP 服务。
24+
- 通过有界读取和恢复胶囊节省上下文的 Agent Skill。
25+
- Codex、Claude Code DSH 安装方式
26+
- `uv` 管理的 Python 3.12 运行时引导;插件用户无需安装系统 Python。
27+
- 相互独立的中英文文档

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
Be respectful, constructive, and specific. Harassment, discrimination, threats,
66
and publication of private information are not acceptable. Maintainers may
7-
remove abusive content or participation to keep the project safe and useful.
7+
remove abusive content or restrict participation to keep the project safe and
8+
useful.
89

910
When disagreeing, focus on observable behavior, reproducible evidence, and the
1011
trade-offs of a proposed change.

CODE_OF_CONDUCT_zh-CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
[English version](CODE_OF_CONDUCT.md)
44

5-
请保持尊重、建设性和具体。骚扰、歧视、威胁以及公开他人隐私信息均不可接受。维护者可以移除滥用性内容或终止相关参与,以维护项目的安全与实用性
5+
请以尊重、建设性且具体的方式参与交流。骚扰、歧视、威胁和公开他人隐私信息均不可接受。为维护项目的安全与实用性,维护者可以移除滥用性内容或限制相关人员参与
66

7-
发生分歧时,请聚焦可观察行为、可复现证据以及拟议变更的取舍
7+
出现分歧时,请聚焦可观察的行为、可复现的证据,以及拟议变更所涉及的取舍

CONTRIBUTING.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[Chinese version](CONTRIBUTING_zh-CN.md)
44

55
Contributions are welcome. Keep the package independent of agent frameworks,
6-
production databases, downloaders, and media providers.
6+
production data stores, downloaders, and media providers.
77

88
## Development setup
99

@@ -13,21 +13,22 @@ python -m pip install -e ".[dev]"
1313
python tests/run.py fast
1414
```
1515

16-
The fast gate is the normal inner loop and has a three-second target. Run
17-
`python tests/run.py list` before choosing a Blender profile.
16+
The `fast` gate is the normal development loop and is designed to finish within
17+
three seconds. Run `python tests/run.py list` before selecting a Blender
18+
profile.
1819

1920
## Where a change belongs
2021

2122
- Public API and collaboration policy: `src/blender_vse/api.py`
2223
- Operation names and classification: `src/blender_vse/catalog.py`
23-
- Fixed bpy templates: `src/blender_vse/blender/vse_ops.py`
24+
- Fixed `bpy` operation templates: `src/blender_vse/blender/vse_ops.py`
2425
- Execution and session policy: `src/blender_vse/blender/runner.py` and
2526
`live_session.py`
26-
- Serialized contracts: `src/blender_vse/schemas`
27+
- Serialized data contracts: `src/blender_vse/schemas`
2728
- Context views and budgets: `src/blender_vse/context.py` and
2829
`context-policy.json`
29-
- Compaction capsule construction: `src/blender_vse/resume.py`
30-
- MCP tool and authorization boundary: `src/blender_vse/mcp`
30+
- Context-compaction capsules: `src/blender_vse/resume.py`
31+
- MCP tools and authorization boundaries: `src/blender_vse/mcp`
3132
- Agent workflow and generated command index: `skills/blender-vse`
3233
- Local plugin metadata and launch contract: `.codex-plugin/plugin.json` and
3334
`.mcp.json`
@@ -38,32 +39,33 @@ The fast gate is the normal inner loop and has a three-second target. Run
3839

3940
## Change checklist
4041

41-
1. Add a focused unit or contract regression first.
42-
2. Keep new bpy operations fixed and type/JSON encoded; never expose arbitrary
43-
Python.
44-
3. Register each public operation in exactly one catalog family and update the
45-
edit-command Schema.
46-
4. Keep bounded read output within the machine-readable context policy; never
47-
introduce a zero-progress cursor.
48-
5. Add real Blender coverage only where a host-side test cannot prove behavior.
49-
6. Keep the public smoke profile small; register broader scripts in
50-
`blender-full`.
42+
1. Start with a focused unit or contract regression test.
43+
2. Keep new `bpy` operations fixed, typed, and JSON-encoded; never expose
44+
arbitrary Python.
45+
3. Register every public operation in exactly one catalog family, and update
46+
the edit-command schema.
47+
4. Keep bounded-read output within the machine-readable context policy, and
48+
never introduce a cursor that makes no progress.
49+
5. Add coverage against real Blender only when a host-side test cannot establish
50+
the behavior.
51+
6. Keep the public smoke profile small; put broader scripts in `blender-full`.
5152
7. Run `python tests/run.py fast` and `python tests/run.py coverage`.
52-
8. After command-signature changes, run
53+
8. After changing a command signature, run
5354
`python skills/blender-vse/scripts/generate_command_index.py` and commit the
5455
generated index.
55-
9. Update public docs and `CHANGELOG.md` when behavior changes.
56+
9. When behavior changes, update the public documentation and both
57+
`CHANGELOG.md` and `CHANGELOG_zh-CN.md`.
5658

57-
Changes to plugin metadata or the stdio launch command must also run
58-
`python tests/run.py plugin` and the active Codex installation's bundled
59-
`plugin-creator` validator.
59+
Changes to plugin metadata or the stdio launch command also require
60+
`python tests/run.py plugin` and the `plugin-creator` validator bundled with the
61+
active Codex installation.
6062

6163
Changes to context budgets, compaction state, observation transitions, or Skill
62-
recovery rules must run `python tests/run.py stateful` and update the model-ready
63-
scenario corpus when behavior intentionally changes.
64+
recovery rules require `python tests/run.py stateful`. If behavior changes
65+
intentionally, update the model-ready scenario corpus as well.
6466

65-
Pull requests that touch session identity, persistence, checkpoint restore,
66-
proxy validation, or direct-mutation policy should also run
67+
Pull requests that affect session identity, persistence, checkpoint restore,
68+
proxy validation, or the direct-mutation policy should also run
6769
`python tests/run.py blender-smoke` on a visible desktop Blender installation.
6870

6971
See [Testing](docs/testing.md) for profile boundaries and safety rules.

CONTRIBUTING_zh-CN.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[English version](CONTRIBUTING.md)
44

5-
欢迎贡献。请保持本包独立于 Agent 框架、生产数据库、下载器和媒体服务商
5+
欢迎贡献。请勿让本包依赖 Agent 框架、生产数据存储、下载器或媒体服务商
66

77
## 开发环境
88

@@ -12,18 +12,19 @@ python -m pip install -e ".[dev]"
1212
python tests/run.py fast
1313
```
1414

15-
`fast` 是日常内部循环,目标为三秒。选择 Blender 档位前先运行 `python tests/run.py list`
15+
`fast` 是日常开发循环,目标耗时不超过三秒。选择 Blender 档位前,请先运行
16+
`python tests/run.py list`
1617

1718
## 变更应放在哪里
1819

1920
- 公开 API 与协作策略:`src/blender_vse/api.py`
2021
- 操作名称与分类:`src/blender_vse/catalog.py`
21-
- 固定 bpy 模板`src/blender_vse/blender/vse_ops.py`
22+
- 固定的 `bpy` 操作模板`src/blender_vse/blender/vse_ops.py`
2223
- 执行与会话策略:`src/blender_vse/blender/runner.py``live_session.py`
23-
- 序列化契约`src/blender_vse/schemas`
24+
- 序列化数据契约`src/blender_vse/schemas`
2425
- 上下文视图与预算:`src/blender_vse/context.py``context-policy.json`
25-
- 压缩胶囊构建`src/blender_vse/resume.py`
26-
- MCP 工具及授权边界`src/blender_vse/mcp`
26+
- 上下文压缩胶囊`src/blender_vse/resume.py`
27+
- MCP 工具和授权边界`src/blender_vse/mcp`
2728
- Agent 工作流与生成的命令索引:`skills/blender-vse`
2829
- 本地插件元数据与启动契约:`.codex-plugin/plugin.json``.mcp.json`
2930
- 确定性插件归档:`scripts/build_plugin.py`
@@ -33,20 +34,24 @@ python tests/run.py fast
3334

3435
## 变更检查清单
3536

36-
1. 先添加聚焦的单元或契约回归测试
37-
2. 新增 bpy 操作必须固定、类型化并经过 JSON 编码;禁止暴露任意 Python。
38-
3. 每个公开操作只登记到一个目录功能族,并更新编辑命令 Schema。
39-
4. 有界读取必须符合机器可读上下文策略,绝不能产生零进度游标
40-
5. 只有宿主侧测试无法证明行为时才增加真实 Blender 覆盖。
41-
6. 公开冒烟档位保持精简;更广的脚本登记到 `blender-full`
37+
1. 先添加一个聚焦的单元或契约回归测试
38+
2. 新增 `bpy` 操作必须固定、类型化并经过 JSON 编码;禁止暴露任意 Python。
39+
3. 每个公开操作只能登记到操作目录中的一个功能族,并同步更新编辑命令 Schema。
40+
4. 有界读取的输出必须符合机器可读的上下文策略,且绝不能产生无法推进的游标
41+
5. 只有宿主侧测试无法证明相关行为时,才添加真实 Blender 覆盖。
42+
6. 保持公开冒烟档位精简;覆盖范围更广的脚本应登记到 `blender-full`
4243
7. 运行 `python tests/run.py fast``python tests/run.py coverage`
43-
8. 命令签名变化后运行 `python skills/blender-vse/scripts/generate_command_index.py`,并提交生成的索引。
44-
9. 行为变化时更新公开文档与 `CHANGELOG.md``CHANGELOG_zh-CN.md`
44+
8. 命令签名发生变化后,运行 `python skills/blender-vse/scripts/generate_command_index.py`
45+
并提交生成的索引。
46+
9. 行为发生变化时,更新公开文档以及 `CHANGELOG.md``CHANGELOG_zh-CN.md`
4547

46-
修改插件元数据或 stdio 启动命令时,还必须运行 `python tests/run.py plugin` 以及当前 Codex 安装附带的 `plugin-creator` 校验器。
48+
修改插件元数据或 stdio 启动命令时,还必须运行 `python tests/run.py plugin`,并使用当前
49+
Codex 安装附带的 `plugin-creator` 校验器。
4750

48-
修改上下文预算、压缩状态、观察状态转换或 Skill 恢复规则时,必须运行 `python tests/run.py stateful`;若行为有意变化,还要更新面向模型的场景语料。
51+
修改上下文预算、压缩状态、观察状态转换或 Skill 恢复规则时,必须运行
52+
`python tests/run.py stateful`;若行为是有意调整,还要更新面向模型的场景语料。
4953

50-
涉及会话身份、持久化、检查点恢复、代理验证或直接修改策略的拉取请求,还应在可见桌面 Blender 环境运行 `python tests/run.py blender-smoke`
54+
涉及会话身份、持久化、检查点恢复、代理验证或直接修改策略的拉取请求,还应在可见的
55+
桌面 Blender 环境中运行 `python tests/run.py blender-smoke`
5156

52-
档位边界与安全规则见[测试指南](docs/testing_zh-CN.md)
57+
有关档位边界和安全规则,请参阅[测试指南](docs/testing_zh-CN.md)

0 commit comments

Comments
 (0)