diffwiki 0.16.0 → 0.17.0

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "diffwiki",
3
- "version": "0.16.0",
3
+ "version": "0.17.0",
4
4
  "description": "diffwiki command-line interface",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -18,7 +18,7 @@
18
18
  "@logtape/logtape": "^2.2.4",
19
19
  "@logtape/file": "^2.2.4",
20
20
  "commander": "^13.0.0",
21
- "diffwiki-core": "0.16.0"
21
+ "diffwiki-core": "0.17.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@types/node": "^22.0.0"
@@ -7,11 +7,15 @@ budget: [100, 500]
7
7
  <!--
8
8
  Use this shape for a collection's root index file. An index groups articles into topics, provides a one-line description for each, and links to them. It does not teach, demonstrate, or narrate.
9
9
 
10
+ Pick an organisation pattern:
11
+ - Subtopic headers — use when the collection spans multiple distinct subjects. One H2 per subject.
12
+ - Shape-based sections — use when the collection covers a single topic but mixes article types. Use H2s: Guides, Recipes, References (omit any that are empty).
13
+
10
14
  Authoring rules:
11
15
  - Adhere to the template structure
12
16
  - One H2 per topic group; keep the group label short (2–4 words)
13
17
  - One bullet per article: [Title](./slug.md) — one-line description
14
- - No prose paragraphs, no examples, no code blocks, no References section
18
+ - No prose paragraphs, no examples, no code blocks
15
19
  - Keep descriptions to a single clause — enough to distinguish siblings
16
20
  - Do not copy over html comments or the template specific yaml frontmatter above this section. Write a diffwiki article yaml frontmatter as shown below this comment.
17
21
  - Use concise descriptive titles in article frontmatter
@@ -26,18 +30,33 @@ tags:
26
30
 
27
31
  - collection-index
28
32
  - TAG1
29
- - TAG2
30
33
  audience: public
31
34
  status: published
32
35
 
33
36
  ---
34
37
 
35
- ## <Topic Group>
38
+ <!-- Pattern A: subtopic headers — use when the collection spans multiple subjects -->
39
+
40
+ ## <Subject Area>
41
+
42
+ - [Article Title](./slug.md) — one-line description.
43
+ - [Article Title](./slug.md) — one-line description.
44
+
45
+ ## <Second Subject Area>
46
+
47
+ - [Article Title](./slug.md) — one-line description.
48
+
49
+ <!-- Pattern B: shape-based sections — use when the collection is single-topic with mixed article types -->
50
+
51
+ ## Guides
52
+
53
+ - [Article Title](./slug.md) — one-line description.
54
+
55
+ ## Recipes
36
56
 
37
- - [Article Title](./slug.md) — one-line description of what this article covers.
38
- - [Article Title](./slug.md) — one-line description of what this article covers.
57
+ - [Article Title](./slug.md) — one-line description.
58
+ - [Article Title](./slug.md) — one-line description.
39
59
 
40
- ## <Second Topic Group>
60
+ ## References
41
61
 
42
- - [Article Title](./slug.md) — one-line description of what this article covers.
43
- - [Article Title](./slug.md) — one-line description of what this article covers.
62
+ - [Article Title](./slug.md) — one-line description.