@orderful/droid 0.21.0 → 0.22.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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @orderful/droid
2
2
 
3
+ ## 0.22.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#113](https://github.com/Orderful/droid/pull/113) [`37245c2`](https://github.com/Orderful/droid/commit/37245c2a54427dc57f54ec80399d827997089e0a) Thanks [@frytyler](https://github.com/frytyler)! - Add `/codex artifact` command for adding supplementary documents to projects. Artifacts are supporting materials like customer interviews, research notes, and meeting summaries that live in `projects/{name}/artifacts/`.
8
+
3
9
  ## 0.21.0
4
10
 
5
11
  ### Minor Changes
@@ -14,15 +14,16 @@ You are a document processor for the Orderful codex. Your job is to transform so
14
14
 
15
15
  You will receive:
16
16
  1. **File path** - The source document to process
17
- 2. **Document type** - One of: `prd`, `tech-design`, `topic`, `pattern`
17
+ 2. **Document type** - One of: `prd`, `tech-design`, `topic`, `pattern`, `artifact`
18
18
  3. **Project/entry name** - Where this should be stored in the codex
19
19
  4. **Codex repo path** - The local path to orderful-codex repository
20
+ 5. **Artifact filename** (optional, for artifacts) - Name for the artifact file
20
21
 
21
22
  ## Validation (Do This First)
22
23
 
23
24
  Before processing, validate all inputs:
24
25
 
25
- 1. **Document type** - Must be one of: `prd`, `tech-design`, `topic`, `pattern`. Reject anything else.
26
+ 1. **Document type** - Must be one of: `prd`, `tech-design`, `topic`, `pattern`, `artifact`. Reject anything else.
26
27
  2. **File path** - Must exist and be readable. Use Read tool to verify.
27
28
  3. **Project/entry name** - Must be safe for filesystem paths:
28
29
  - Only allow: alphanumeric, dashes, underscores
@@ -44,10 +45,13 @@ From the content, identify:
44
45
  - **Title** - The document/feature name
45
46
  - **Main content** - The substantive information
46
47
  - **Codebase paths** (if tech-design) - Any code paths mentioned
47
- - **Source** - Default to `confluence` for PRDs/tech-designs, `exploration` for topics
48
+ - **Source** - Default based on type:
49
+ - PRD/tech-design: `confluence`
50
+ - Topic/pattern: `exploration`
51
+ - Artifact: infer from content (`interview`, `transcript`, `notes`, `meeting`, `research`, `spike`, `analysis`)
48
52
  - **Status** - Default based on type:
49
53
  - PRD/tech-design: `draft` (new imports start as drafts)
50
- - Topic/pattern: `active` (explorations are immediately usable)
54
+ - Topic/pattern/artifact: `active`
51
55
 
52
56
  ### 3. Read and Apply Frontmatter Template
53
57
 
@@ -58,7 +62,8 @@ From the content, identify:
58
62
  | `prd` | `{codex_repo}/templates/PRD.md` |
59
63
  | `tech-design` | `{codex_repo}/templates/TECH-DESIGN.md` |
60
64
  | `topic` | `{codex_repo}/templates/TOPIC.md` |
61
- | `pattern` | `{codex_repo}/templates/PATTERN.md` (if exists, else use TOPIC.md) |
65
+ | `pattern` | `{codex_repo}/templates/PATTERN.md` |
66
+ | `artifact` | `{codex_repo}/templates/ARTIFACT.md` |
62
67
 
63
68
  1. Read the appropriate template file
64
69
  2. Extract its frontmatter structure
@@ -90,6 +95,9 @@ Write the processed markdown to the correct location:
90
95
  | `tech-design` | `{codex_repo}/projects/{name}/TECH-DESIGN.md` |
91
96
  | `topic` | `{codex_repo}/topics/{name}.md` |
92
97
  | `pattern` | `{codex_repo}/patterns/{name}.md` |
98
+ | `artifact` | `{codex_repo}/projects/{name}/artifacts/{filename}.md` |
99
+
100
+ For artifacts, derive `{filename}` from the artifact filename input or the source file's name (slugified).
93
101
 
94
102
  Create the directory if it doesn't exist.
95
103
 
@@ -123,6 +123,7 @@ The codex has three categories:
123
123
  | `/codex new {name}` | Scaffold new project from templates |
124
124
  | `/codex decision {text}` | Append to active project's DECISIONS.md |
125
125
  | `/codex snapshot {type} {file} {name}` | Import PDF/markdown to codex (uses agent) |
126
+ | `/codex artifact {file} {project}` | Add supporting artifact to project (uses agent) |
126
127
  | `/codex add topic {name}` | Add explored topic with freshness metadata |
127
128
 
128
129
  ## Loading an Entry
@@ -270,6 +271,32 @@ Full procedure: `references/topics.md`
270
271
  The agent handles: PDF reading, content extraction, frontmatter generation, file writing.
271
272
  The main conversation handles: git branch, commit, PR creation, user interaction.
272
273
 
274
+ ## Adding Artifacts
275
+
276
+ **Trigger:** `/codex artifact {file} {project}` or user wants to add supporting material to a project
277
+
278
+ Artifacts are supplementary documents that support a project but aren't core document types (PRD, TECH-DESIGN, DECISIONS). Examples:
279
+ - Customer interviews / transcripts
280
+ - Research notes
281
+ - Meeting summaries
282
+ - Spike findings
283
+ - Competitor analysis
284
+
285
+ **Procedure:**
286
+
287
+ 1. Use the `codex-document-processor` agent with type `artifact`
288
+ 2. Agent writes to `{codex_repo}/projects/{project}/artifacts/{filename}.md`
289
+ 3. Handle git workflow (branch, commit, PR)
290
+
291
+ **Example invocations:**
292
+
293
+ ```bash
294
+ /codex artifact ~/Downloads/customer-interview-acme.pdf transaction-templates
295
+ /codex artifact ~/notes/spike-handlebars-perf.md partnership-automation
296
+ ```
297
+
298
+ Artifacts get lighter frontmatter with `type: artifact` and source like `interview`, `transcript`, `notes`, `meeting`, `research`, `spike`, or `analysis`.
299
+
273
300
  ## Creating New Projects
274
301
 
275
302
  **Trigger:** `/codex new {name}` or user wants to start new project entry
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orderful/droid",
3
- "version": "0.21.0",
3
+ "version": "0.22.0",
4
4
  "description": "AI workflow toolkit for sharing skills, commands, and agents across the team",
5
5
  "type": "module",
6
6
  "bin": {
@@ -14,15 +14,16 @@ You are a document processor for the Orderful codex. Your job is to transform so
14
14
 
15
15
  You will receive:
16
16
  1. **File path** - The source document to process
17
- 2. **Document type** - One of: `prd`, `tech-design`, `topic`, `pattern`
17
+ 2. **Document type** - One of: `prd`, `tech-design`, `topic`, `pattern`, `artifact`
18
18
  3. **Project/entry name** - Where this should be stored in the codex
19
19
  4. **Codex repo path** - The local path to orderful-codex repository
20
+ 5. **Artifact filename** (optional, for artifacts) - Name for the artifact file
20
21
 
21
22
  ## Validation (Do This First)
22
23
 
23
24
  Before processing, validate all inputs:
24
25
 
25
- 1. **Document type** - Must be one of: `prd`, `tech-design`, `topic`, `pattern`. Reject anything else.
26
+ 1. **Document type** - Must be one of: `prd`, `tech-design`, `topic`, `pattern`, `artifact`. Reject anything else.
26
27
  2. **File path** - Must exist and be readable. Use Read tool to verify.
27
28
  3. **Project/entry name** - Must be safe for filesystem paths:
28
29
  - Only allow: alphanumeric, dashes, underscores
@@ -44,10 +45,13 @@ From the content, identify:
44
45
  - **Title** - The document/feature name
45
46
  - **Main content** - The substantive information
46
47
  - **Codebase paths** (if tech-design) - Any code paths mentioned
47
- - **Source** - Default to `confluence` for PRDs/tech-designs, `exploration` for topics
48
+ - **Source** - Default based on type:
49
+ - PRD/tech-design: `confluence`
50
+ - Topic/pattern: `exploration`
51
+ - Artifact: infer from content (`interview`, `transcript`, `notes`, `meeting`, `research`, `spike`, `analysis`)
48
52
  - **Status** - Default based on type:
49
53
  - PRD/tech-design: `draft` (new imports start as drafts)
50
- - Topic/pattern: `active` (explorations are immediately usable)
54
+ - Topic/pattern/artifact: `active`
51
55
 
52
56
  ### 3. Read and Apply Frontmatter Template
53
57
 
@@ -58,7 +62,8 @@ From the content, identify:
58
62
  | `prd` | `{codex_repo}/templates/PRD.md` |
59
63
  | `tech-design` | `{codex_repo}/templates/TECH-DESIGN.md` |
60
64
  | `topic` | `{codex_repo}/templates/TOPIC.md` |
61
- | `pattern` | `{codex_repo}/templates/PATTERN.md` (if exists, else use TOPIC.md) |
65
+ | `pattern` | `{codex_repo}/templates/PATTERN.md` |
66
+ | `artifact` | `{codex_repo}/templates/ARTIFACT.md` |
62
67
 
63
68
  1. Read the appropriate template file
64
69
  2. Extract its frontmatter structure
@@ -90,6 +95,9 @@ Write the processed markdown to the correct location:
90
95
  | `tech-design` | `{codex_repo}/projects/{name}/TECH-DESIGN.md` |
91
96
  | `topic` | `{codex_repo}/topics/{name}.md` |
92
97
  | `pattern` | `{codex_repo}/patterns/{name}.md` |
98
+ | `artifact` | `{codex_repo}/projects/{name}/artifacts/{filename}.md` |
99
+
100
+ For artifacts, derive `{filename}` from the artifact filename input or the source file's name (slugified).
93
101
 
94
102
  Create the directory if it doesn't exist.
95
103
 
@@ -123,6 +123,7 @@ The codex has three categories:
123
123
  | `/codex new {name}` | Scaffold new project from templates |
124
124
  | `/codex decision {text}` | Append to active project's DECISIONS.md |
125
125
  | `/codex snapshot {type} {file} {name}` | Import PDF/markdown to codex (uses agent) |
126
+ | `/codex artifact {file} {project}` | Add supporting artifact to project (uses agent) |
126
127
  | `/codex add topic {name}` | Add explored topic with freshness metadata |
127
128
 
128
129
  ## Loading an Entry
@@ -270,6 +271,32 @@ Full procedure: `references/topics.md`
270
271
  The agent handles: PDF reading, content extraction, frontmatter generation, file writing.
271
272
  The main conversation handles: git branch, commit, PR creation, user interaction.
272
273
 
274
+ ## Adding Artifacts
275
+
276
+ **Trigger:** `/codex artifact {file} {project}` or user wants to add supporting material to a project
277
+
278
+ Artifacts are supplementary documents that support a project but aren't core document types (PRD, TECH-DESIGN, DECISIONS). Examples:
279
+ - Customer interviews / transcripts
280
+ - Research notes
281
+ - Meeting summaries
282
+ - Spike findings
283
+ - Competitor analysis
284
+
285
+ **Procedure:**
286
+
287
+ 1. Use the `codex-document-processor` agent with type `artifact`
288
+ 2. Agent writes to `{codex_repo}/projects/{project}/artifacts/{filename}.md`
289
+ 3. Handle git workflow (branch, commit, PR)
290
+
291
+ **Example invocations:**
292
+
293
+ ```bash
294
+ /codex artifact ~/Downloads/customer-interview-acme.pdf transaction-templates
295
+ /codex artifact ~/notes/spike-handlebars-perf.md partnership-automation
296
+ ```
297
+
298
+ Artifacts get lighter frontmatter with `type: artifact` and source like `interview`, `transcript`, `notes`, `meeting`, `research`, `spike`, or `analysis`.
299
+
273
300
  ## Creating New Projects
274
301
 
275
302
  **Trigger:** `/codex new {name}` or user wants to start new project entry