From 57c1c0e124c10ad80625a65b0a6c3abdc01213ea Mon Sep 17 00:00:00 2001
From: wujunchen <wujunchen@baidu.com>
Date: Wed, 29 Apr 2026 14:09:55 +0800
Subject: [PATCH] docs: document e2e contract gate

Change-Id: I940bac18e567c55a7cd57e1ccf37203f871c6aec
---
 .e2e/README.md  | 5 ++++-
 README.md       | 8 ++++++++
 README.zh-CN.md | 8 ++++++++
 3 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/.e2e/README.md b/.e2e/README.md
index 959c3c8..f8e8ad2 100644
--- a/.e2e/README.md
+++ b/.e2e/README.md
@@ -7,9 +7,12 @@ The runner clears stale artifacts, executes the real `npm test` gate, records
 Run the host-neutral gate with:
 
 ```bash
-E2E_CONTRACT_VALIDATOR_PYTHONPATH=/Users/wujunchen/dev/github.com/fancive/claude-code-addons/scripts \
 bash .e2e/gate.sh --json
 ```
 
+If `e2e_contract_validator` is not installed, set
+`E2E_CONTRACT_VALIDATOR_PYTHONPATH` to the `claude-code-addons/scripts`
+directory before running the gate.
+
 Generated artifacts under `.e2e/artifact.json` and `.e2e/results/` are runtime
 evidence and are intentionally ignored by git.
diff --git a/README.md b/README.md
index 4c55439..3d35732 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,14 @@ npm run lint      # Biome
 npm test          # build + typecheck + tests
 ```
 
+The project also has a host-neutral e2e contract gate:
+
+```bash
+bash .e2e/gate.sh --json
+```
+
+If `e2e_contract_validator` is not installed, set `E2E_CONTRACT_VALIDATOR_PYTHONPATH` to the `claude-code-addons/scripts` directory before running the gate. Runtime evidence such as `.e2e/artifact.json` and `.e2e/results/` is generated locally and ignored by git.
+
 ## Star History
 
 <a href="https://www.star-history.com/#fancive/obsidian-parallel-reader&Date">
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 00a231a..7a3d0a6 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -111,6 +111,14 @@ npm run lint      # Biome
 npm test          # 构建 + 类型检查 + 测试
 ```
 
+项目还提供一个与宿主环境解耦的 e2e contract gate：
+
+```bash
+bash .e2e/gate.sh --json
+```
+
+如果本机没有安装 `e2e_contract_validator`，运行前把 `E2E_CONTRACT_VALIDATOR_PYTHONPATH` 指向 `claude-code-addons/scripts` 目录。`.e2e/artifact.json`、`.e2e/results/` 等运行证据只在本地生成，并已被 git 忽略。
+
 ## Star History
 
 <a href="https://www.star-history.com/#fancive/obsidian-parallel-reader&Date">