Skip to content

Commit b35f82b

Browse files
committed
Merge remote-tracking branch 'origin/main' into feat/20260604-issue-26-sim-screenshot-orientation
# Conflicts: # docs-linhay/memory/2026-06-04.md
2 parents 252c6bb + 26fd564 commit b35f82b

4 files changed

Lines changed: 86 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,35 @@ Before filing a public issue, redact private project and personal information. D
1515
| Build, test, run, and diagnose an unknown Apple repo | [CLI Integration Guide](#cli-integration-guide) | Use `triton xcode`, `triton xcresult`, and artifact commands before raw `xcodebuild`. |
1616
| Prepare a HarmonyOS / DevEco Emulator | [Harmony App Integration Guide](#harmony-app-integration-guide) | Host-side HDC adapter works without embedded runtime. |
1717
| Validate a Harmony embedded runtime | [Harmony App Integration Guide](#harmony-app-integration-guide) | Use package id / import path `tritonkit` and `--runtime-base-url` direct checks while the SDK is standalone. |
18+
| Add optional Codex / agent workflows | [Optional Agent Skills](#optional-agent-skills) | Install only the public skills; internal skills are for TritonKit repository maintenance. |
19+
20+
## Optional Agent Skills
21+
22+
TritonKit ships optional Codex / agent skills for AI-assisted adoption, feedback, and local emulator regression work. They are not required to use the iOS runtime, Harmony runtime notes, or macOS `triton` CLI.
23+
24+
External users and adopting projects should install only the public skills from `.agents/tritonkit-skills/public/` or from the release asset `tritonkit-skills.tar.gz`. Current public skills are:
25+
26+
- `tritonkit-dev-feedback`: collect adoption feedback, missing capabilities, confusing behavior, and documentation gaps as actionable TritonKit issues.
27+
- `tritonkit-emulator-cli-takeover`: guide local CLI takeover of iOS Simulator, Android Emulator, and HarmonyOS / DevEco Emulator workflows.
28+
- `tritonkit-real-project-regression`: validate TritonKit against real app projects while isolating external repo changes and preserving machine-readable evidence.
29+
30+
Do not install `.agents/tritonkit-skills/internal/` into adopting projects by default. Internal skills are repo-maintenance, governance, planning, supervision, and implementation workflows for TritonKit maintainers, and release packaging excludes them.
31+
32+
If you install from a source checkout, copy only the public skill directories into your Codex / agent skills directory:
33+
34+
```sh
35+
# Replace AGENT_SKILLS_DIR with your Codex / agent's configured skills directory.
36+
mkdir -p "$AGENT_SKILLS_DIR"
37+
cp -R .agents/tritonkit-skills/public/* "$AGENT_SKILLS_DIR"/
38+
```
39+
40+
If you install from a release asset, extract the public skill bundle into that same configured skills directory:
41+
42+
```sh
43+
tar -xzf tritonkit-skills.tar.gz -C "$AGENT_SKILLS_DIR"
44+
```
45+
46+
Restart the Codex / agent session after installation so the new skills are discovered.
1847

1948
## iOS Embedded Runtime Integration Guide
2049

docs-linhay/memory/2026-06-04.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# 2026-06-04
2+
3+
## Issue #27 Optional Agent Skills README
4+
5+
-`docs-linhay/spaces/20260604-issue-27-agent-skills-readme/` 建立执行计划,验收聚焦根 README 是否明确可选 Codex / agent skills 的 public/internal 边界。
6+
- 根 README 新增 `Optional Agent Skills` 章节:外部用户只安装 `.agents/tritonkit-skills/public/` 或 release asset `tritonkit-skills.tar.gz` 中的 public skills;当前 public skills 为 `tritonkit-dev-feedback``tritonkit-emulator-cli-takeover``tritonkit-real-project-regression``.agents/tritonkit-skills/internal/` 仅用于 TritonKit repo maintenance,不默认安装到 adopting projects;安装后需重启 Codex / agent session。
17

28
## Issue 26 simulator screenshot orientation metadata
39

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Issue 27 - Clarify optional Codex/agent skills installation in README
2+
3+
## 背景
4+
5+
GitHub Issue #27 指出:根 README 已覆盖 iOS embedded runtime、macOS CLI 与 Harmony / DevEco 集成路径,但没有明显说明 TritonKit 随附的可选 Codex/agent skills 安装路径,外部采用项目容易遗漏自动化指导。
6+
7+
## 目标
8+
9+
- 在根 README 的集成/安装说明中增加简短的 Optional Agent Skills 说明。
10+
- 明确外部用户只安装 `.agents/tritonkit-skills/public/` 下的 public skills。
11+
- 明确 `.agents/tritonkit-skills/internal/` 仅用于 TritonKit 仓库维护,不应作为外部项目默认安装内容。
12+
- 提醒安装后重启 Codex / agent session 以重新发现 skills。
13+
14+
## 非目标
15+
16+
- 不改动 skill 打包逻辑。
17+
- 不新增 Web/Wails UI。
18+
- 不改动 CLI/HTTP 业务契约。
19+
20+
## BDD 场景与验收
21+
22+
### 场景:外部采用者从根 README 发现可选 agent skills
23+
24+
Given 外部采用者阅读根 README
25+
When 查找 TritonKit 可选自动化/agent 指南
26+
Then README 应展示 Optional Agent Skills 章节
27+
And 列出 public skill 路径
28+
And 说明 internal skills 不面向外部默认安装
29+
And 提醒安装后重启 Codex / agent session
30+
31+
## 相关链接
32+
33+
- GitHub Issue: https://github.com/NeptuneKit/TritonKit/issues/27
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Issue 27 实施计划
2+
3+
## BDD 验收
4+
5+
- Given 外部采用者阅读根 README
6+
- When 查找 TritonKit 可选 Codex / agent skills 安装说明
7+
- Then README 展示 `Optional Agent Skills` 章节
8+
- And 明确 public skill 源路径 `.agents/tritonkit-skills/public/` 与 release asset `tritonkit-skills.tar.gz`
9+
- And 列出当前 public skills:`tritonkit-dev-feedback``tritonkit-emulator-cli-takeover``tritonkit-real-project-regression`
10+
- And 说明 `.agents/tritonkit-skills/internal/` 仅用于 TritonKit repo maintenance,不默认安装到 adopting projects
11+
- And 提醒安装后重启 Codex / agent session
12+
13+
## 执行步骤
14+
15+
1. 阅读 space README、根 README、`.agents/tritonkit-skills/README.md` 与 public skill front matter,确认 packaging 只包含 public skills。
16+
2. 在根 README 集成路径表后补充 `Optional Agent Skills` 章节。
17+
3. 运行 `docs-linhay/scripts/check-docs.sh` 做纯文档结构校验。
18+
4. 写回 memory 并提交本地 commit。

0 commit comments

Comments
 (0)