Skip to content

Commit 53906a7

Browse files
Document state accounting in API and output docs
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent 01d35f8 commit 53906a7

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/output-layout.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Within this bundle, `code2skill` treats generated Skills as the final product la
3939
- `references/*.md`: supporting architectural and workflow references
4040
- `state/analysis-state.json`: incremental execution cache
4141

42+
When `write_state` is enabled, both `report.json` accounting and `ScanExecution.output_files` include `state/analysis-state.json` in this intermediate layer.
43+
4244
In product terms, `.code2skill/` is the workspace-local artifact bundle. The final repository-local product is the generated Skill set, while `adapt` publishes that Skill layer into the repository locations where each AI tool expects to read it.
4345

4446
## Adapted Outputs

docs/python-api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ The pipeline functions return `ScanExecution`, which includes:
7676
- `report_path`
7777
- `report`
7878

79+
When state persistence is enabled, `output_files` includes the state snapshot path as part of the written intermediate artifact set.
80+
7981
The embedded `ExecutionReport` also distinguishes between:
8082

8183
- `final_product_files`: the generated Skill artifacts inside the bundle

0 commit comments

Comments
 (0)