@haposoft/cafekit 0.8.14 → 0.8.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/package.json +1 -1
- package/src/claude/skills/docs/SKILL.md +17 -15
- package/src/claude/skills/docs/references/init-workflow.md +3 -3
- package/src/claude/skills/docs/references/reconstruct-workflow.md +1 -1
- package/src/claude/skills/docs/references/standard-docs-workflow.md +1 -1
- package/src/claude/skills/docs/references/summarize-workflow.md +1 -1
- package/src/claude/skills/docs/references/update-workflow.md +1 -1
package/README.md
CHANGED
|
@@ -80,7 +80,7 @@ CafeKit ships many skills, but the main release surface is:
|
|
|
80
80
|
- `/hapo:develop <feature-name>`: implement from approved spec artifacts
|
|
81
81
|
- `/hapo:debug <issue>`: diagnose bugs, incidents, CI failures, flaky tests, UI regressions, and performance issues before fixing
|
|
82
82
|
- `/hapo:hotfix <issue>`: fix diagnosed bugs with root-cause, verification, prevention, and side-effect gates
|
|
83
|
-
- `/hapo:docs [init
|
|
83
|
+
- `/hapo:docs [--init|--update|--summarize|--reconstruct]`: create project docs or reconstruct as-is system documentation from source code
|
|
84
84
|
- `/hapo:test [scope|--full]`: run verification and return a structured verdict
|
|
85
85
|
- `/hapo:code-review [scope|--pending]`: adversarial review focused on correctness, regressions, and security
|
|
86
86
|
- `/hapo:generate-graph <diagram request>`: generate technical SVG/PNG diagrams
|
|
@@ -129,7 +129,7 @@ Generate a diagram:
|
|
|
129
129
|
Reconstruct current-state docs for an existing or legacy system:
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
/hapo:docs reconstruct apps/legacy-admin
|
|
132
|
+
/hapo:docs --reconstruct apps/legacy-admin
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
The reconstruct bundle includes as-is markdown/JSON evidence and a self-contained `overview.html` review dashboard before the approved docs are handed to `/hapo:specs`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@haposoft/cafekit",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.15",
|
|
4
4
|
"description": "Claude Code-first spec-driven workflow for AI coding assistants. Bundles CafeKit hapo: skills, runtime hooks, agents, and installer scaffolding.",
|
|
5
5
|
"author": "Haposoft <nghialt@haposoft.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: hapo:docs
|
|
3
3
|
description: "Create, update, summarize, or reconstruct project/system documentation from source code. Use reconstruct mode for as-is documentation of existing or legacy systems with evidence and uncertainty tracking."
|
|
4
4
|
version: 1.0.0
|
|
5
|
-
argument-hint: "[init
|
|
5
|
+
argument-hint: "[--init|--update|--summarize|--reconstruct] [scope]"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Docs
|
|
@@ -18,12 +18,14 @@ Project documentation workflow for CafeKit.
|
|
|
18
18
|
|
|
19
19
|
```text
|
|
20
20
|
/hapo:docs
|
|
21
|
-
/hapo:docs init
|
|
22
|
-
/hapo:docs update
|
|
23
|
-
/hapo:docs summarize
|
|
24
|
-
/hapo:docs reconstruct <scope>
|
|
21
|
+
/hapo:docs --init
|
|
22
|
+
/hapo:docs --update
|
|
23
|
+
/hapo:docs --summarize
|
|
24
|
+
/hapo:docs --reconstruct <scope>
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
Mode flags are exclusive. When one is present, use it as the selected mode before interpreting any natural-language scope or instructions.
|
|
28
|
+
|
|
27
29
|
## Default Behavior
|
|
28
30
|
|
|
29
31
|
Parse the user intent before selecting a mode.
|
|
@@ -90,9 +92,9 @@ docs/as-is/<scope-slug>/
|
|
|
90
92
|
└── unknowns-and-assumptions.md
|
|
91
93
|
```
|
|
92
94
|
|
|
93
|
-
##
|
|
95
|
+
## Mode Flags
|
|
94
96
|
|
|
95
|
-
###
|
|
97
|
+
### `--init`
|
|
96
98
|
|
|
97
99
|
Create the standard project docs set from the current source code.
|
|
98
100
|
|
|
@@ -105,7 +107,7 @@ Load:
|
|
|
105
107
|
- `references/standard-docs-workflow.md`
|
|
106
108
|
- `references/init-workflow.md`
|
|
107
109
|
|
|
108
|
-
###
|
|
110
|
+
### `--update`
|
|
109
111
|
|
|
110
112
|
Refresh existing docs after code changes.
|
|
111
113
|
|
|
@@ -118,7 +120,7 @@ Load:
|
|
|
118
120
|
- `references/standard-docs-workflow.md`
|
|
119
121
|
- `references/update-workflow.md`
|
|
120
122
|
|
|
121
|
-
###
|
|
123
|
+
### `--summarize`
|
|
122
124
|
|
|
123
125
|
Create or update only `codebase-summary.md`.
|
|
124
126
|
|
|
@@ -130,7 +132,7 @@ Load:
|
|
|
130
132
|
- `references/standard-docs-workflow.md`
|
|
131
133
|
- `references/summarize-workflow.md`
|
|
132
134
|
|
|
133
|
-
###
|
|
135
|
+
### `--reconstruct`
|
|
134
136
|
|
|
135
137
|
Rebuild current-state, as-is system documentation from source code.
|
|
136
138
|
|
|
@@ -153,7 +155,7 @@ Load:
|
|
|
153
155
|
|
|
154
156
|
## Reconstruction Is Not Specs
|
|
155
157
|
|
|
156
|
-
`hapo:docs reconstruct` MUST NOT:
|
|
158
|
+
`hapo:docs --reconstruct` MUST NOT:
|
|
157
159
|
|
|
158
160
|
- design future behavior
|
|
159
161
|
- add new requirements
|
|
@@ -165,7 +167,7 @@ Load:
|
|
|
165
167
|
Correct handoff:
|
|
166
168
|
|
|
167
169
|
```text
|
|
168
|
-
/hapo:docs reconstruct <scope>
|
|
170
|
+
/hapo:docs --reconstruct <scope>
|
|
169
171
|
-> human review of as-is docs
|
|
170
172
|
-> /hapo:specs <modernization or change request>
|
|
171
173
|
-> /hapo:develop <feature>
|
|
@@ -202,9 +204,9 @@ For broad inputs such as `.`, `/`, `whole repo`, or `entire system`:
|
|
|
202
204
|
Prefer:
|
|
203
205
|
|
|
204
206
|
```text
|
|
205
|
-
/hapo:docs reconstruct apps/admin
|
|
206
|
-
/hapo:docs reconstruct modules/expense-approval
|
|
207
|
-
/hapo:docs reconstruct src/features/order
|
|
207
|
+
/hapo:docs --reconstruct apps/admin
|
|
208
|
+
/hapo:docs --reconstruct modules/expense-approval
|
|
209
|
+
/hapo:docs --reconstruct src/features/order
|
|
208
210
|
```
|
|
209
211
|
|
|
210
212
|
Avoid reconstructing a large monolith in one pass unless the user explicitly accepts lower precision.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Init Workflow
|
|
2
2
|
|
|
3
|
-
Use with `/hapo:docs init`.
|
|
3
|
+
Use with `/hapo:docs --init`.
|
|
4
4
|
|
|
5
5
|
## Goal
|
|
6
6
|
|
|
@@ -45,7 +45,7 @@ Do not create a large document solely to fill the table. If a core file cannot b
|
|
|
45
45
|
|
|
46
46
|
1. Read repo instructions and runtime docs root.
|
|
47
47
|
2. Detect whether docs already exist.
|
|
48
|
-
3. If user specifically asked
|
|
48
|
+
3. If user specifically asked `--init` and docs exist, preserve existing content:
|
|
49
49
|
- read it first
|
|
50
50
|
- merge or add missing baseline sections
|
|
51
51
|
- do not overwrite human-written docs blind
|
|
@@ -126,7 +126,7 @@ Report:
|
|
|
126
126
|
Recommended next command:
|
|
127
127
|
|
|
128
128
|
```text
|
|
129
|
-
/hapo:docs update
|
|
129
|
+
/hapo:docs --update
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
after meaningful source changes.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Standard Docs Workflow
|
|
2
2
|
|
|
3
|
-
Use this shared contract for `/hapo:docs init`, `/hapo:docs update`, and `/hapo:docs summarize`.
|
|
3
|
+
Use this shared contract for `/hapo:docs --init`, `/hapo:docs --update`, and `/hapo:docs --summarize`.
|
|
4
4
|
|
|
5
5
|
Then load the mode-specific reference:
|
|
6
6
|
|