Skip to content

Commit 71bd6a9

Browse files
committed
docs: consolidate troubleshooting in readmes
1 parent 3891c48 commit 71bd6a9

2 files changed

Lines changed: 22 additions & 30 deletions

File tree

README-zh.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@
6868
严格按照 https://github.com/MaxMiksa/Codex-Workflow-Folder/blob/main/docs/UNINSTALL_FOR_AI.md 的步骤卸载该功能,不要自由发挥。
6969
```
7070

71+
## 其他
72+
7173
<details>
7274
<summary>环境要求与限制</summary>
7375

@@ -81,24 +83,18 @@
8183
- 运行测试:`npm test`
8284
- 应用补丁:`npm run apply`
8385
- 验证(不落盘):`npm run verify`
86+
- 技术栈:Node.js(ESM)、JavaScript/Markdown、VS Code 扩展 host/webview 产物补丁
8487
</details>
8588

8689
<details>
87-
<summary>开发栈</summary>
88-
89-
1. Packages & Frameworks
90-
- Node.js(ESM)
91-
2. Interfaces & Services
92-
- VS Code 扩展 host/webview 产物补丁
93-
3. Languages
94-
- JavaScript, Markdown
95-
</details>
96-
97-
<details>
98-
<summary>FAQ / 排错</summary>
99-
100-
- 没生效:重启 VS Code。
101-
- 扩展更新后失效:重新执行 `npm run apply`
90+
<summary>排错 / 已知问题</summary>
91+
92+
- 没生效:安装/卸载后需重启 VS Code。
93+
- 扩展更新后失效:官方扩展更新可能覆盖被 patch 的产物;更新后重新执行安装 Prompt(或运行 `npm run apply`)。
94+
- Remote 环境不保证:Remote-SSH / WSL / Dev Containers 可能把扩展放在服务器侧路径(例如 `.vscode-server/extensions`),默认脚本可能 patch 到错误位置。
95+
- 找不到 Node:安装脚本需要 `node` 可在 `PATH` 中被找到。
96+
- 网络受限:如 `raw.githubusercontent.com` 被阻断,请改用 `docs/INSTALL_FOR_AI.md` 中的 GitHub `.../raw/...` 备用链接。
97+
- 版本漂移:如果脚本提示找不到锚点/匹配失败,说明上游扩展结构变更;请停止并提交 Issue,附上扩展版本号与报错信息。
10298
</details>
10399

104100
## 🤝 贡献与联系

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ To remove the feature, send this prompt to Codex and restart VS Code:
6969
Strictly follow https://github.com/MaxMiksa/Codex-Workflow-Folder/blob/main/docs/UNINSTALL_FOR_AI.md to uninstall this feature. Do not improvise.
7070
```
7171

72+
## More Info
73+
7274
<details>
7375
<summary>Requirements & Limits</summary>
7476

@@ -82,24 +84,18 @@ Strictly follow https://github.com/MaxMiksa/Codex-Workflow-Folder/blob/main/docs
8284
- Run tests: `npm test`
8385
- Apply patch: `npm run apply`
8486
- Verify (no-op): `npm run verify`
87+
- Stack: Node.js (ESM), JS/Markdown, VS Code extension host + webview bundle patching
8588
</details>
8689

8790
<details>
88-
<summary>Development Stack</summary>
89-
90-
1. Packages & Frameworks
91-
- Node.js (ESM)
92-
2. Interfaces & Services
93-
- VS Code extension host JS + webview bundle patching
94-
3. Languages
95-
- JavaScript, Markdown
96-
</details>
97-
98-
<details>
99-
<summary>FAQ / Troubleshooting</summary>
100-
101-
- If nothing changes, restart VS Code.
102-
- If VS Code updates the extension, re-run `npm run apply`.
91+
<summary>Troubleshooting / Known Issues</summary>
92+
93+
- Restart required: if nothing changes, restart VS Code after install/uninstall.
94+
- Official extension updates: updates can overwrite patched artifacts; re-run the install prompt (or `npm run apply`) after an update.
95+
- Remote environments: Remote-SSH / WSL / Dev Containers may store extensions under server-side paths (e.g. `.vscode-server/extensions`), so the default script may patch the wrong place.
96+
- Node missing: the install script requires `node` available in `PATH`.
97+
- Network blocked: if `raw.githubusercontent.com` is blocked, use the GitHub `.../raw/...` fallback URLs in `docs/INSTALL_FOR_AI.md`.
98+
- Version drift: if the script reports missing anchors, upstream changed; stop and open an issue with your extension version and the reported mismatch.
10399
</details>
104100

105101
## 🤝 Contribution & Contact

0 commit comments

Comments
 (0)