You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,8 @@ Once that information is materialized as Skills, it can be consumed directly by
45
45
46
46
It covers the full chain from repository scanning, structural analysis, Skill planning, and document generation to tool-specific rule adaptation. It also supports incremental regeneration so Skills can stay aligned as the repository evolves.
47
47
48
+
In product terms, the final deliverable is the Skill layer itself. Generated Skills under `skills/` and the tool-specific files published by `adapt` are the end product. Blueprints, plans, reports, references, and state snapshots remain explicit intermediate artifacts that support review, debugging, and CI-safe refresh.
49
+
48
50
For one-off local analysis, `code2skill` can scan an entire repository and generate the full result set.
49
51
For ongoing development workflows, it can combine historical state and code diffs to rebuild only the affected Skills, reducing repeated generation cost and making CI-based updates practical.
50
52
@@ -94,13 +96,15 @@ This is not the final architecture destination, but it is a meaningful step upwa
94
96
95
97
From one Python repository, `code2skill` can produce:
96
98
97
-
-`project-summary.md` for a human-readable repository overview
98
-
-`skill-blueprint.json` for the Phase 1 structural blueprint
99
-
-`skill-plan.json` for the LLM-planned skill set
100
-
-`skills/index.md` and `skills/*.md` for grounded AI-consumable skill documents
101
-
-`AGENTS.md`, `CLAUDE.md`, `.cursor/rules/*`, `.github/copilot-instructions.md`, and `.windsurfrules` via `adapt`
102
-
-`report.json` for execution metrics, token estimates, and impact summaries
103
-
-`state/analysis-state.json` for incremental CI reuse
99
+
- final Skill products
100
+
-`skills/index.md` and `skills/*.md` for grounded AI-consumable skill documents
101
+
-`AGENTS.md`, `CLAUDE.md`, `.cursor/rules/*`, `.github/copilot-instructions.md`, and `.windsurfrules` via `adapt`
102
+
- intermediate artifacts
103
+
-`project-summary.md` for a human-readable repository overview
104
+
-`skill-blueprint.json` for the Phase 1 structural blueprint
105
+
-`skill-plan.json` for the LLM-planned skill set
106
+
-`report.json` for execution metrics, token estimates, and impact summaries
107
+
-`state/analysis-state.json` for incremental CI reuse
Copy file name to clipboardExpand all lines: docs/output-layout.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ By default, `code2skill` writes artifacts under `.code2skill/` inside the target
4
4
5
5
This directory is the default artifact bundle root for the repository workflow. It groups the structural analysis outputs, planning outputs, generated Skills, diagnostics, and incremental state under one predictable location.
6
6
7
+
Within this bundle, `code2skill` treats generated Skills as the final product layer. The other files remain important, but they are intermediate artifacts that support generation, review, reporting, and incremental CI refresh.
8
+
7
9
```text
8
10
.code2skill/
9
11
project-summary.md
@@ -24,14 +26,20 @@ This directory is the default artifact bundle root for the repository workflow.
24
26
25
27
## Artifact Roles
26
28
29
+
### Final product artifacts
30
+
31
+
-`skills/index.md` and `skills/*.md`: grounded AI-consumable Skill documents
In product terms, `.code2skill/` is the workspace-local artifact bundle, while `adapt`writes the final target-facing instruction files into the repository locations where each AI tool expects them.
42
+
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.
Copy file name to clipboardExpand all lines: docs/python-api.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,11 @@ The pipeline functions return `ScanExecution`, which includes:
76
76
-`report_path`
77
77
-`report`
78
78
79
+
The embedded `ExecutionReport` also distinguishes between:
80
+
81
+
-`final_product_files`: the generated Skill artifacts inside the bundle
82
+
-`intermediate_artifact_files`: blueprint, plan, references, report, and state-side artifacts that support the workflow
83
+
79
84
The lower-level config and report dataclasses are also exported from the package root. The package root also exports the new artifact and summary contracts used by the workflow-oriented surface:
0 commit comments