Skip to content

Commit 01d35f8

Browse files
Document state artifact accounting in README pages
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent 95d5cd7 commit 01d35f8

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ From one Python repository, `code2skill` can produce:
106106
- `report.json` for execution metrics, token estimates, and impact summaries
107107
- `state/analysis-state.json` for incremental CI reuse
108108

109+
When state writing is enabled, both `report.json` and the returned `ScanExecution.output_files` account for `state/analysis-state.json` as an intermediate artifact rather than a final Skill product.
110+
109111
## The Role Of Skills In A Repository
110112

111113
Skills are the standardized AI-facing expression layer of repository knowledge.

README.zh-CN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ Skill 可以表达例如以下信息:
105105
- `report.json`:执行指标、token 估算和影响摘要
106106
- `state/analysis-state.json`:供增量 CI 复用的状态快照
107107

108+
当启用 state 写出时,`report.json` 和返回的 `ScanExecution.output_files` 都会把 `state/analysis-state.json` 记作中间工件,而不是最终 Skill 产物。
109+
108110
## Skill 在仓库中的角色
109111

110112
Skill 是仓库知识面向 AI 的标准化表达层。

0 commit comments

Comments
 (0)