@thjodann/wk 1.0.2 → 1.0.3
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 +14 -9
- package/docs/reference.md +11 -7
- package/docs/setup.md +5 -0
- package/package.json +1 -1
- package/skills/wk/SKILL.md +12 -0
package/README.md
CHANGED
|
@@ -141,11 +141,15 @@ Wikiwiki is an article-first CLI foundation. It currently includes:
|
|
|
141
141
|
- optional read-only Beads integration for developer work context
|
|
142
142
|
- public npm package `@thjodann/wk`
|
|
143
143
|
- GitHub Release-based npm publishing through Trusted Publishing
|
|
144
|
+
- bundled Codex skill behavior where bare `wk`/`/wk` opens the generated site
|
|
145
|
+
- dogfooded article pages for this repo's generated wiki
|
|
144
146
|
- CI and tests
|
|
145
147
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
148
|
+
The package and release foundation is complete enough for regular patch
|
|
149
|
+
releases. The current polish milestone is `1.0.3 Open the Wiki`: make bare
|
|
150
|
+
`/wk` show the generated site and make this repo's own generated wiki useful at
|
|
151
|
+
first glance. The next larger feature remains draft review flows for approving
|
|
152
|
+
or rejecting closeout and compile drafts.
|
|
149
153
|
|
|
150
154
|
Generated `wiki/` and `wiki-site/` are intentionally not shipped in the npm
|
|
151
155
|
package. Installed users generate their own copies from their own records.
|
|
@@ -194,9 +198,10 @@ not release commitments.
|
|
|
194
198
|
|
|
195
199
|
| Planned feature | Completion | Notes |
|
|
196
200
|
| --- | ---: | --- |
|
|
197
|
-
| `1.0.
|
|
198
|
-
|
|
|
199
|
-
|
|
|
201
|
+
| `1.0.3` Open the Wiki | 95% | Bare `wk`/`/wk` opens an existing generated site, five starter article records seed this repo's wiki, and package docs point at the current release path. |
|
|
202
|
+
| Package and release foundation | 96% | README/docs/skill files ship in npm, generated dogfood output and `assets/wikiwiki-banner.png` stay out of the tarball, and GitHub Releases drive Trusted Publishing with a manual 2FA fallback. |
|
|
203
|
+
| Agent setup polish | 88% | `wk setup --agent codex` and `wk install-agent codex` preserve the bundled skill behavior; remaining work is broader target support and clearer destination previews. |
|
|
204
|
+
| Draft review flows | 45% | Closeout and compile draft packets exist; structured approve, reject, and apply flows are the next larger feature after `1.0.3`. |
|
|
200
205
|
| Richer symbol extraction | 20% | Symbol records and pages exist, but important symbols are still captured manually. |
|
|
201
206
|
| Watch mode | 10% | Batch commands exist for `status`, `spin`, and `closeout`; no file watcher is built yet. |
|
|
202
207
|
| `scratch` review command | 10% | Validation and search exist; contradiction, drift, and stale-knowledge review is not a dedicated command yet. |
|
|
@@ -208,9 +213,9 @@ not release commitments.
|
|
|
208
213
|
|
|
209
214
|
Shared completion snapshot:
|
|
210
215
|
|
|
211
|
-
- Package and release foundation: about
|
|
212
|
-
- Named future roadmap: about
|
|
213
|
-
- Blended overall product vision: about
|
|
216
|
+
- Package and release foundation: about 96%
|
|
217
|
+
- Named future roadmap: about 45%
|
|
218
|
+
- Blended overall product vision: about 77%
|
|
214
219
|
|
|
215
220
|
## License
|
|
216
221
|
|
package/docs/reference.md
CHANGED
|
@@ -313,8 +313,10 @@ not on every push to `main`; npm versions are immutable, so each release needs a
|
|
|
313
313
|
new `package.json` version first. If a release is re-run for a version that is
|
|
314
314
|
already on npm, the workflow skips `npm publish` after tests and validation pass.
|
|
315
315
|
|
|
316
|
-
The
|
|
317
|
-
|
|
316
|
+
The package and release foundation is complete enough for regular patch
|
|
317
|
+
releases. Prefer the workflow end-to-end; if npm Trusted Publishing rejects a
|
|
318
|
+
release, publish manually with the owner account and npm 2FA, then let the
|
|
319
|
+
workflow rerun or skip the already-published version.
|
|
318
320
|
|
|
319
321
|
Release checklist:
|
|
320
322
|
|
|
@@ -356,13 +358,14 @@ Wikiwiki is an article-first CLI foundation. It currently includes:
|
|
|
356
358
|
- optional read-only Beads integration with developer-only `work.html`
|
|
357
359
|
- public npm package `@thjodann/wk`
|
|
358
360
|
- GitHub Release-based npm publishing through Trusted Publishing
|
|
361
|
+
- bundled Codex skill behavior where bare `wk`/`/wk` opens the generated site
|
|
362
|
+
- dogfooded article pages for this repo's generated wiki
|
|
359
363
|
- CI and tests
|
|
360
364
|
|
|
361
365
|
Some planned pieces are not built yet:
|
|
362
366
|
|
|
363
|
-
- `1.0.1` package/docs polish
|
|
364
|
-
- richer symbol extraction
|
|
365
367
|
- draft review flows
|
|
368
|
+
- richer symbol extraction
|
|
366
369
|
- watch mode
|
|
367
370
|
|
|
368
371
|
Generated `wiki/` and `wiki-site/` are intentionally not shipped in the npm
|
|
@@ -374,9 +377,10 @@ Roadmap estimates are rough planning signals, not release commitments.
|
|
|
374
377
|
|
|
375
378
|
| Area | Completion | Next |
|
|
376
379
|
| --- | ---: | --- |
|
|
377
|
-
| `1.0.
|
|
378
|
-
|
|
|
379
|
-
|
|
|
380
|
+
| `1.0.3` Open the Wiki | 95% | Bare `wk`/`/wk` opens an existing generated site, five starter article records seed this repo's wiki, and package docs point at the current release path. |
|
|
381
|
+
| Package and release foundation | 96% | README/docs/skill files ship in npm, generated dogfood output and `assets/wikiwiki-banner.png` stay out of the tarball, and GitHub Releases drive Trusted Publishing with a manual 2FA fallback. |
|
|
382
|
+
| Agent setup polish | 88% | `wk setup --agent codex` and `wk install-agent codex` preserve the bundled skill behavior; future work is broader target support and clearer destination previews. |
|
|
383
|
+
| Draft review flows | 45% | Closeout and compile drafts exist; approving, rejecting, and applying record drafts is the next larger feature after `1.0.3`. |
|
|
380
384
|
| Richer symbol extraction | 20% | Symbol records and pages exist, but extraction is still mostly manual. |
|
|
381
385
|
| Watch mode | 10% | Batch commands exist; no file watcher is built yet. |
|
|
382
386
|
| `scratch` review command | 10% | Validation and search exist; contradiction, drift, and stale-knowledge review is not a dedicated command yet. |
|
package/docs/setup.md
CHANGED
|
@@ -206,6 +206,11 @@ while overwriting the bundled `wk` skill files:
|
|
|
206
206
|
wk install-agent codex --yes --force
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
+
Once installed, a bare `wk`, `/wk`, `$wk`, or linked `$wk` request means "show
|
|
210
|
+
me the generated wiki site." The skill should return one concise link to an
|
|
211
|
+
existing `wiki-site/index.html`; it should not run status/spin, generate files,
|
|
212
|
+
start a server, or explain the skill for that bare invocation.
|
|
213
|
+
|
|
209
214
|
To install manually on macOS or Linux:
|
|
210
215
|
|
|
211
216
|
```sh
|
package/package.json
CHANGED
package/skills/wk/SKILL.md
CHANGED
|
@@ -11,6 +11,18 @@ Use `wk` as the repo-local memory loop for agents. It keeps durable project know
|
|
|
11
11
|
|
|
12
12
|
Prefer JSON output, preserve user work, and treat structured records as the source of truth. Records are the ledger; articles are the wiki. Lean on deterministic CLI commands for status, validation, rendering, site generation, and search; use model judgment for deciding what knowledge matters, updating public article prose, attaching source records, and polishing drafts. The generated site should feel like the user's project wiki; keep Wikiwiki itself quiet unless credit or setup context is needed.
|
|
13
13
|
|
|
14
|
+
## Bare Invocation Default
|
|
15
|
+
|
|
16
|
+
When the user invokes only `wk`, `/wk`, `$wk`, or `[$wk](...)` with no
|
|
17
|
+
additional request, treat it as "show me the generated wiki site." Do not run
|
|
18
|
+
the normal status/spin workflow, do not modify files, and do not explain the
|
|
19
|
+
skill. Find the current repo root or workspace, prefer an existing
|
|
20
|
+
`wiki-site/index.html`, and return a single concise Markdown link using the
|
|
21
|
+
absolute local file path. If the site is already known to be served through a
|
|
22
|
+
local URL, a direct URL to that same generated site is also acceptable. Do not
|
|
23
|
+
start a server just for a bare invocation. If no generated site exists, say so
|
|
24
|
+
briefly and suggest `wk site --audience all` or the repo's `wiki:site` script.
|
|
25
|
+
|
|
14
26
|
## Start Of Work
|
|
15
27
|
|
|
16
28
|
1. Find the repo root before running `wk`.
|