skill-family-doc-render 0.4.0 → 0.4.1
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/CHANGELOG.md +7 -0
- package/README.md +17 -16
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -16,21 +16,22 @@ publication APIs. A failure before commit removes staging and leaves the existin
|
|
|
16
16
|
untouched. After commit, or when publication is indeterminate, staging or displaced data may
|
|
17
17
|
remain for diagnosis; the renderer does not guess or roll back.
|
|
18
18
|
|
|
19
|
-
> **Version boundary:** this source tree is version `0.4.
|
|
20
|
-
> official npm registry before treating it as installable. Version 0.4.
|
|
21
|
-
> `editorial
|
|
19
|
+
> **Version boundary:** this source tree is version `0.4.1`. Verify that exact version in the
|
|
20
|
+
> official npm registry before treating it as installable. Version 0.4.1 preserves the
|
|
21
|
+
> `markdown-v1`, `editorial`, and `--check-project` behavior introduced in 0.4.0 and aligns the
|
|
22
|
+
> renderer, documentation plugin, and public site at 0.4.1 for the joint release.
|
|
22
23
|
|
|
23
24
|
## Install
|
|
24
25
|
|
|
25
26
|
After confirming availability, install this release with an exact version:
|
|
26
27
|
|
|
27
28
|
```sh
|
|
28
|
-
npm install --save-exact skill-family-doc-render@0.4.
|
|
29
|
+
npm install --save-exact skill-family-doc-render@0.4.1
|
|
29
30
|
```
|
|
30
31
|
|
|
31
32
|
Requires Node.js `>=22.22.2 <23` (aligned with the skill-family foundation packages).
|
|
32
33
|
|
|
33
|
-
Version 0.4.
|
|
34
|
+
Version 0.4.1 has exact runtime dependencies on `marked@18.0.11`,
|
|
34
35
|
`skill-family-contracts@0.18.0`, and `skill-family-harness-node@0.18.0`. `marked` supplies the
|
|
35
36
|
Markdown lexer; the renderer applies its own restricted-format validation before passing semantic
|
|
36
37
|
content to the template. The workspace profile check separately uses
|
|
@@ -41,25 +42,25 @@ notes.
|
|
|
41
42
|
|
|
42
43
|
## CLI
|
|
43
44
|
|
|
44
|
-
Use the exact 0.4.
|
|
45
|
+
Use the exact 0.4.1 CLI for rendering, checks, coverage maintenance, and the Git index assertion:
|
|
45
46
|
|
|
46
47
|
```sh
|
|
47
48
|
# render all repos with a site field (writes to disk)
|
|
48
|
-
npx skill-family-doc-render@0.4.
|
|
49
|
+
npx skill-family-doc-render@0.4.1
|
|
49
50
|
|
|
50
51
|
# drift check only: compare in-memory render against committed site-baseline.json, write nothing
|
|
51
|
-
npx skill-family-doc-render@0.4.
|
|
52
|
+
npx skill-family-doc-render@0.4.1 --check
|
|
52
53
|
|
|
53
54
|
# render / check a single repo by name
|
|
54
|
-
npx skill-family-doc-render@0.4.
|
|
55
|
+
npx skill-family-doc-render@0.4.1 --repo <name>
|
|
55
56
|
|
|
56
57
|
# additionally assert every rendered file is tracked in the git index
|
|
57
|
-
npx skill-family-doc-render@0.4.
|
|
58
|
+
npx skill-family-doc-render@0.4.1 --assert-git
|
|
58
59
|
|
|
59
60
|
# inspect or refresh the reviewed product-input snapshot
|
|
60
|
-
npx skill-family-doc-render@0.4.
|
|
61
|
-
npx skill-family-doc-render@0.4.
|
|
62
|
-
npx skill-family-doc-render@0.4.
|
|
61
|
+
npx skill-family-doc-render@0.4.1 --status --repo <name>
|
|
62
|
+
npx skill-family-doc-render@0.4.1 --refresh-coverage --repo <name>
|
|
63
|
+
npx skill-family-doc-render@0.4.1 --check-project --repo <name>
|
|
63
64
|
```
|
|
64
65
|
|
|
65
66
|
The current directory must be the workspace that owns `public-release.json`. From this package's
|
|
@@ -273,7 +274,7 @@ Foundation packages below, it uses exact `marked@18.0.11` for Markdown tokenizat
|
|
|
273
274
|
Apache-2.0
|
|
274
275
|
|
|
275
276
|
<!-- release-skill:capability:safe-first-command -->
|
|
276
|
-
> **Start here:** run `npx skill-family-doc-render@0.4.
|
|
277
|
+
> **Start here:** run `npx skill-family-doc-render@0.4.1 --check-project --repo <name>` after
|
|
277
278
|
> confirming that exact release in the official registry. From a local checkout, use
|
|
278
279
|
> `node bin/skill-family-doc-render.mjs --check-project --repo <name>`. The check is read-only:
|
|
279
280
|
> it renders in memory, compares against the committed `site-baseline.json`, writes
|
|
@@ -297,6 +298,6 @@ Apache-2.0
|
|
|
297
298
|
Display help and run a read-only project check:
|
|
298
299
|
|
|
299
300
|
```sh
|
|
300
|
-
npx skill-family-doc-render@0.4.
|
|
301
|
-
npx skill-family-doc-render@0.4.
|
|
301
|
+
npx skill-family-doc-render@0.4.1 --help
|
|
302
|
+
npx skill-family-doc-render@0.4.1 --check-project --repo <name>
|
|
302
303
|
```
|
package/package.json
CHANGED