@crewx/doc 0.1.9-rc.166 → 0.1.9-rc.168

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.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/SKILL.md +38 -38
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -3,5 +3,5 @@
3
3
  Markdown TOC extraction and section management for CrewX.
4
4
 
5
5
  ```bash
6
- npx doc toc <file>
6
+ crewx doc toc <file>
7
7
  ```
package/SKILL.md CHANGED
@@ -28,28 +28,28 @@ Use this skill in the following situations:
28
28
 
29
29
  ```bash
30
30
  # Create a new document
31
- npx doc create docs/research "New Document Title" --tags=tag1,tag2 --category=research
31
+ crewx doc create docs/research "New Document Title" --tags=tag1,tag2 --category=research
32
32
 
33
33
  # Extract TOC
34
- npx doc toc docs/design-spec.md
34
+ crewx doc toc docs/design-spec.md
35
35
 
36
36
  # Extract specific section only
37
- npx doc section docs/design-spec.md "API Design"
37
+ crewx doc section docs/design-spec.md "API Design"
38
38
 
39
39
  # Implementation status summary
40
- npx doc summary docs/design-spec.md
40
+ crewx doc summary docs/design-spec.md
41
41
 
42
42
  # Document indexing (frontmatter-based)
43
- npx doc index
43
+ crewx doc index
44
44
 
45
45
  # BM25 document search
46
- npx doc find "onboarding"
46
+ crewx doc find "onboarding"
47
47
 
48
48
  # Inter-document knowledge graph
49
- npx doc graph
49
+ crewx doc graph
50
50
 
51
51
  # Tag aggregation
52
- npx doc tags
52
+ crewx doc tags
53
53
  ```
54
54
 
55
55
  ## Commands
@@ -57,7 +57,7 @@ npx doc tags
57
57
  ### create - Create New Document
58
58
 
59
59
  ```bash
60
- npx doc create <dir> "<title>" [--tags=t1,t2] [--category=cat] [--author=agent] [--body="content"]
60
+ crewx doc create <dir> "<title>" [--tags=t1,t2] [--category=cat] [--author=agent] [--body="content"]
61
61
  ```
62
62
 
63
63
  Creates a new markdown document with frontmatter in the specified directory.
@@ -86,10 +86,10 @@ Created: docs/research/test-document.md
86
86
  **Examples:**
87
87
  ```bash
88
88
  # Basic creation
89
- npx doc create docs/research "Test Document" --tags=test --category=research
89
+ crewx doc create docs/research "Test Document" --tags=test --category=research
90
90
 
91
91
  # With author and body content
92
- npx doc create docs/research "API Design Doc" --tags=api,design --category=design --author=core_dev --body="## Overview\n\nAPI design document."
92
+ crewx doc create docs/research "API Design Doc" --tags=api,design --category=design --author=core_dev --body="## Overview\n\nAPI design document."
93
93
  ```
94
94
 
95
95
  **Note:** An error occurs if a file already exists at the same path.
@@ -97,7 +97,7 @@ npx doc create docs/research "API Design Doc" --tags=api,design --category=desig
97
97
  ### toc - Extract Table of Contents
98
98
 
99
99
  ```bash
100
- npx doc toc <file> [--depth=N]
100
+ crewx doc toc <file> [--depth=N]
101
101
  ```
102
102
 
103
103
  Extracts all headings (#, ##, ###, etc.) from a markdown file and outputs them in tree format.
@@ -117,7 +117,7 @@ Extracts all headings (#, ##, ###, etc.) from a markdown file and outputs them i
117
117
  ### section - Extract Specific Section
118
118
 
119
119
  ```bash
120
- npx doc section <file> <heading>
120
+ crewx doc section <file> <heading>
121
121
  ```
122
122
 
123
123
  Extracts a specific heading and its sub-content. Useful for viewing only the relevant part without reading the entire document.
@@ -125,16 +125,16 @@ Extracts a specific heading and its sub-content. Useful for viewing only the rel
125
125
  **Examples:**
126
126
  ```bash
127
127
  # Extract only the "API Design" section
128
- npx doc section docs/design-spec.md "API Design"
128
+ crewx doc section docs/design-spec.md "API Design"
129
129
 
130
130
  # Search by ID
131
- npx doc section docs/design-spec.md "api-design"
131
+ crewx doc section docs/design-spec.md "api-design"
132
132
  ```
133
133
 
134
134
  ### status - View TOC with Status Markers
135
135
 
136
136
  ```bash
137
- npx doc status <file>
137
+ crewx doc status <file>
138
138
  ```
139
139
 
140
140
  Outputs the TOC while displaying the implementation status of each section.
@@ -148,7 +148,7 @@ Outputs the TOC while displaying the implementation status of each section.
148
148
  ### summary - Implementation Status Summary
149
149
 
150
150
  ```bash
151
- npx doc summary <file>
151
+ crewx doc summary <file>
152
152
  ```
153
153
 
154
154
  Aggregates and summarizes the implementation status across the entire document.
@@ -156,7 +156,7 @@ Aggregates and summarizes the implementation status across the entire document.
156
156
  ### index - Document Indexing
157
157
 
158
158
  ```bash
159
- npx doc index [dir]
159
+ crewx doc index [dir]
160
160
  ```
161
161
 
162
162
  Parses and indexes frontmatter from markdown files in the directory.
@@ -176,7 +176,7 @@ Indexed 17 documents from docs/
176
176
  ### find - BM25 Document Search
177
177
 
178
178
  ```bash
179
- npx doc find <query> [dir]
179
+ crewx doc find <query> [dir]
180
180
  ```
181
181
 
182
182
  Finds related documents using frontmatter-based BM25 search.
@@ -198,7 +198,7 @@ Found 3 results:
198
198
  ### graph - Document Knowledge Graph
199
199
 
200
200
  ```bash
201
- npx doc graph [dir]
201
+ crewx doc graph [dir]
202
202
  ```
203
203
 
204
204
  Automatically analyzes inter-document relationships and generates a knowledge graph.
@@ -222,7 +222,7 @@ Edges:
222
222
  ### tags - Tag Aggregation
223
223
 
224
224
  ```bash
225
- npx doc tags [dir]
225
+ crewx doc tags [dir]
226
226
  ```
227
227
 
228
228
  Collects tags from all documents and aggregates them by frequency.
@@ -241,7 +241,7 @@ Tags (51 unique):
241
241
  ### properties - Frontmatter Property Values
242
242
 
243
243
  ```bash
244
- npx doc properties [dir]
244
+ crewx doc properties [dir]
245
245
  ```
246
246
 
247
247
  Collects and displays unique values of frontmatter properties used across documents. Currently aggregates `type` and `category` fields.
@@ -319,51 +319,51 @@ tags: [cli, proxy] # cli-proxy-design -> connected via 'cli' tag
319
319
 
320
320
  ```bash
321
321
  # 1. First understand the TOC structure
322
- npx doc toc docs/design-spec.md --depth=2
322
+ crewx doc toc docs/design-spec.md --depth=2
323
323
 
324
324
  # 2. View details for sections of interest only
325
- npx doc section docs/design-spec.md "Settlement Management"
325
+ crewx doc section docs/design-spec.md "Settlement Management"
326
326
  ```
327
327
 
328
328
  ### 2. Tracking Implementation Progress
329
329
 
330
330
  ```bash
331
331
  # Check status summary
332
- npx doc summary docs/design-spec.md
332
+ crewx doc summary docs/design-spec.md
333
333
 
334
334
  # Check unimplemented items in detailed TOC
335
- npx doc status docs/design-spec.md
335
+ crewx doc status docs/design-spec.md
336
336
  ```
337
337
 
338
338
  ### 3. Knowledge Graph Usage
339
339
 
340
340
  ```bash
341
341
  # 1. Get overview of all documents
342
- npx doc index
342
+ crewx doc index
343
343
 
344
344
  # 2. Search for related documents
345
- npx doc find "authentication"
345
+ crewx doc find "authentication"
346
346
 
347
347
  # 3. Visualize inter-document relationships
348
- npx doc graph
348
+ crewx doc graph
349
349
 
350
350
  # 4. Check tag distribution -- review classification system
351
- npx doc tags
351
+ crewx doc tags
352
352
 
353
353
  # 5. Property value overview -- verify frontmatter consistency
354
- npx doc properties
354
+ crewx doc properties
355
355
  ```
356
356
 
357
357
  ### 4. Adding Frontmatter When Writing New Documents
358
358
 
359
359
  ```bash
360
360
  # 1. Check existing categories/tags
361
- npx doc properties
362
- npx doc tags
361
+ crewx doc properties
362
+ crewx doc tags
363
363
 
364
364
  # 2. Write document with appropriate frontmatter
365
365
  # 3. Verify indexing
366
- npx doc index
366
+ crewx doc index
367
367
  ```
368
368
 
369
369
  ## Design Document Recommendations
@@ -395,16 +395,16 @@ Manage Open Knowledge Format (OKF) frontmatter — generate, validate, and norma
395
395
 
396
396
  ```bash
397
397
  # Create new file with OKF skeleton
398
- npx doc okf init docs/foo.md --title="Foo" --type=Reference --tags=api,guide
398
+ crewx doc okf init docs/foo.md --title="Foo" --type=Reference --tags=api,guide
399
399
 
400
400
  # Validate OKF frontmatter (exits non-zero on error)
401
- npx doc okf validate docs/foo.md
401
+ crewx doc okf validate docs/foo.md
402
402
 
403
403
  # Normalize: fill missing OKF fields in-place (idempotent)
404
- npx doc okf normalize docs/foo.md
404
+ crewx doc okf normalize docs/foo.md
405
405
 
406
406
  # Dry-run: preview normalization without writing
407
- npx doc okf normalize docs/foo.md --dry-run
407
+ crewx doc okf normalize docs/foo.md --dry-run
408
408
  ```
409
409
 
410
410
  **OKF frontmatter skeleton:**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crewx/doc",
3
- "version": "0.1.9-rc.166",
3
+ "version": "0.1.9-rc.168",
4
4
  "description": "Markdown TOC extraction and section management for CrewX",
5
5
  "type": "commonjs",
6
6
  "main": "dist/src/engine.js",
@@ -34,8 +34,8 @@
34
34
  "license": "MIT",
35
35
  "dependencies": {
36
36
  "js-yaml": "^4.1.1",
37
- "@crewx/shared": "0.0.6-rc.88",
38
- "@crewx/knowledge-core": "0.1.17-rc.183"
37
+ "@crewx/shared": "0.0.6-rc.90",
38
+ "@crewx/knowledge-core": "0.1.17-rc.185"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@types/js-yaml": "^4.0.9",