@orderful/droid 0.6.0 → 0.7.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 +8 -0
- package/bun.lock +1 -1
- package/dist/skills/brain/SKILL.md +144 -0
- package/dist/skills/brain/SKILL.yaml +31 -0
- package/dist/skills/brain/commands/README.md +7 -0
- package/dist/skills/brain/commands/brain.md +45 -0
- package/dist/skills/brain/references/metadata.md +59 -0
- package/dist/skills/brain/references/naming.md +48 -0
- package/dist/skills/brain/references/templates.md +102 -0
- package/dist/skills/brain/references/workflows.md +188 -0
- package/dist/skills/brain-obsidian/SKILL.md +108 -0
- package/dist/skills/brain-obsidian/SKILL.yaml +45 -0
- package/dist/skills/brain-obsidian/references/templates.md +144 -0
- package/dist/skills/brain-obsidian/references/workflows.md +192 -0
- package/package.json +1 -1
- package/src/skills/brain/SKILL.md +144 -0
- package/src/skills/brain/SKILL.yaml +31 -0
- package/src/skills/brain/commands/README.md +7 -0
- package/src/skills/brain/commands/brain.md +45 -0
- package/src/skills/brain/references/metadata.md +59 -0
- package/src/skills/brain/references/naming.md +48 -0
- package/src/skills/brain/references/templates.md +102 -0
- package/src/skills/brain/references/workflows.md +188 -0
- package/src/skills/brain-obsidian/SKILL.md +108 -0
- package/src/skills/brain-obsidian/SKILL.yaml +45 -0
- package/src/skills/brain-obsidian/references/templates.md +144 -0
- package/src/skills/brain-obsidian/references/workflows.md +192 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Obsidian Brain Templates
|
|
2
|
+
|
|
3
|
+
Templates with YAML frontmatter and wikilink support.
|
|
4
|
+
|
|
5
|
+
## Plan Template
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
---
|
|
9
|
+
type: plan
|
|
10
|
+
status: exploring
|
|
11
|
+
created: {date}
|
|
12
|
+
updated: {date}
|
|
13
|
+
project: "[[{project}]]"
|
|
14
|
+
tags: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# {Topic}
|
|
18
|
+
|
|
19
|
+
Planning {brief description}.
|
|
20
|
+
|
|
21
|
+
## Context
|
|
22
|
+
|
|
23
|
+
What we're solving and why.
|
|
24
|
+
|
|
25
|
+
## Exploration
|
|
26
|
+
|
|
27
|
+
Options and approaches considered.
|
|
28
|
+
|
|
29
|
+
## Decision
|
|
30
|
+
|
|
31
|
+
What we chose and why.
|
|
32
|
+
|
|
33
|
+
## Next Steps
|
|
34
|
+
|
|
35
|
+
- [ ] Action items
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Research Template
|
|
39
|
+
|
|
40
|
+
```markdown
|
|
41
|
+
---
|
|
42
|
+
type: research
|
|
43
|
+
status: exploring
|
|
44
|
+
created: {date}
|
|
45
|
+
updated: {date}
|
|
46
|
+
project: "[[{project}]]"
|
|
47
|
+
tags: []
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
# {Topic}
|
|
51
|
+
|
|
52
|
+
Researching {brief description}.
|
|
53
|
+
|
|
54
|
+
## Questions
|
|
55
|
+
|
|
56
|
+
What we're trying to understand.
|
|
57
|
+
|
|
58
|
+
## Findings
|
|
59
|
+
|
|
60
|
+
What we've learned.
|
|
61
|
+
|
|
62
|
+
## Summary
|
|
63
|
+
|
|
64
|
+
Key takeaways.
|
|
65
|
+
|
|
66
|
+
## Related
|
|
67
|
+
|
|
68
|
+
- [[related-note-1]]
|
|
69
|
+
- [[related-note-2]]
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Review Template
|
|
73
|
+
|
|
74
|
+
```markdown
|
|
75
|
+
---
|
|
76
|
+
type: review
|
|
77
|
+
status: exploring
|
|
78
|
+
created: {date}
|
|
79
|
+
updated: {date}
|
|
80
|
+
project: "[[{project}]]"
|
|
81
|
+
tags: []
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
# {Topic}
|
|
85
|
+
|
|
86
|
+
Reviewing {brief description}.
|
|
87
|
+
|
|
88
|
+
## Overview
|
|
89
|
+
|
|
90
|
+
What's being reviewed and scope.
|
|
91
|
+
|
|
92
|
+
## Observations
|
|
93
|
+
|
|
94
|
+
Key findings and notes.
|
|
95
|
+
|
|
96
|
+
## Recommendations
|
|
97
|
+
|
|
98
|
+
Suggested changes or actions.
|
|
99
|
+
|
|
100
|
+
## Verdict
|
|
101
|
+
|
|
102
|
+
Overall assessment.
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Note Template
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
---
|
|
109
|
+
type: note
|
|
110
|
+
created: {date}
|
|
111
|
+
tags: []
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
# {Brief Title}
|
|
115
|
+
|
|
116
|
+
{content}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Template Variables
|
|
120
|
+
|
|
121
|
+
| Variable | Description | Example |
|
|
122
|
+
|----------|-------------|---------|
|
|
123
|
+
| `{Topic}` | Doc title from user input | "Auth Refactor" |
|
|
124
|
+
| `{date}` | Current date (YYYY-MM-DD) | "2025-01-15" |
|
|
125
|
+
| `{brief description}` | Context from conversation | "refactoring the authentication system" |
|
|
126
|
+
| `{project}` | Active project name (if any) | "transaction-templates" |
|
|
127
|
+
| `{content}` | User-provided text | (for notes) |
|
|
128
|
+
|
|
129
|
+
## Frontmatter Fields
|
|
130
|
+
|
|
131
|
+
| Field | Type | Description |
|
|
132
|
+
|-------|------|-------------|
|
|
133
|
+
| `type` | string | Doc type: `plan`, `research`, `review`, `note` |
|
|
134
|
+
| `status` | string | Lifecycle: `exploring`, `drafting`, `decided`, `done`, `stale` |
|
|
135
|
+
| `created` | date | Creation date (YYYY-MM-DD) |
|
|
136
|
+
| `updated` | date | Last modification date |
|
|
137
|
+
| `project` | wikilink | Link to related project: `"[[project-name]]"` |
|
|
138
|
+
| `tags` | list | Tags for filtering: `[tag1, tag2]` |
|
|
139
|
+
|
|
140
|
+
## Wikilink Conventions
|
|
141
|
+
|
|
142
|
+
- Project links: `[[project-name]]` or `[[1-Projects/project-name/PROJECT]]`
|
|
143
|
+
- Related notes: `[[note-name]]`
|
|
144
|
+
- Use Obsidian's autocomplete to find existing notes
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
# Obsidian Brain Workflows
|
|
2
|
+
|
|
3
|
+
Obsidian-specific procedures that override brain defaults.
|
|
4
|
+
|
|
5
|
+
## Creating Docs
|
|
6
|
+
|
|
7
|
+
**Overrides:** brain's Creating workflow
|
|
8
|
+
|
|
9
|
+
**Steps:**
|
|
10
|
+
|
|
11
|
+
1. **Resolve paths from config:**
|
|
12
|
+
- `brain_dir` from brain skill (your vault path)
|
|
13
|
+
- `inbox_folder` from brain-obsidian (default: `0-Inbox`)
|
|
14
|
+
|
|
15
|
+
2. **Target folder:** `{brain_dir}/{inbox_folder}/`
|
|
16
|
+
|
|
17
|
+
3. **Generate filename** using brain's naming conventions:
|
|
18
|
+
- Format: `{type}-{topic-slug}.md`
|
|
19
|
+
|
|
20
|
+
4. **Check for active project:**
|
|
21
|
+
- If `/project` was loaded this session, use its name for `project` field
|
|
22
|
+
- Otherwise, leave `project` field empty or ask user
|
|
23
|
+
|
|
24
|
+
5. **Apply Obsidian template** from `references/templates.md`:
|
|
25
|
+
- Include YAML frontmatter with all fields
|
|
26
|
+
- Set `created` and `updated` to today
|
|
27
|
+
- Set `status: exploring`
|
|
28
|
+
|
|
29
|
+
6. **Create the file** in vault
|
|
30
|
+
|
|
31
|
+
7. **Set as active doc** (same as brain)
|
|
32
|
+
|
|
33
|
+
## Opening Docs
|
|
34
|
+
|
|
35
|
+
**Overrides:** brain's Opening workflow
|
|
36
|
+
|
|
37
|
+
**Steps:**
|
|
38
|
+
|
|
39
|
+
1. **Search in brain_dir** (your vault):
|
|
40
|
+
```
|
|
41
|
+
Glob: {brain_dir}/**/*{topic}*.md
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
2. **Rest of workflow same as brain** (fuzzy match, select, read, set active)
|
|
45
|
+
|
|
46
|
+
## Updating Frontmatter
|
|
47
|
+
|
|
48
|
+
When modifying any brain doc:
|
|
49
|
+
|
|
50
|
+
1. **Update the `updated` field** to current date
|
|
51
|
+
2. **Update `status`** if work has progressed
|
|
52
|
+
3. **Add `project` link** if doc becomes associated with a project
|
|
53
|
+
|
|
54
|
+
## Finalizing
|
|
55
|
+
|
|
56
|
+
**Overrides:** brain's Finalizing workflow
|
|
57
|
+
|
|
58
|
+
**Steps:**
|
|
59
|
+
|
|
60
|
+
1. **Read active doc** and current location
|
|
61
|
+
|
|
62
|
+
2. **Update frontmatter:**
|
|
63
|
+
- Set `status: done`
|
|
64
|
+
- Update `updated` date
|
|
65
|
+
|
|
66
|
+
3. **Suggest destination based on content and config:**
|
|
67
|
+
|
|
68
|
+
**Without PARA (`para_structure: false`):**
|
|
69
|
+
| Condition | Suggested Destination |
|
|
70
|
+
|-----------|----------------------|
|
|
71
|
+
| Done/stale | `{archive_folder}/` |
|
|
72
|
+
| Still useful in inbox | Keep in place |
|
|
73
|
+
|
|
74
|
+
**With PARA (`para_structure: true`):**
|
|
75
|
+
| Condition | Suggested Destination |
|
|
76
|
+
|-----------|----------------------|
|
|
77
|
+
| Has active project link | `{projects_folder}/` |
|
|
78
|
+
| Ongoing area of responsibility | `{areas_folder}/` |
|
|
79
|
+
| Reference/learning value | `{resources_folder}/` |
|
|
80
|
+
| Stale or obsolete | `{archive_folder}/` |
|
|
81
|
+
|
|
82
|
+
4. **Confirm move with user** before relocating
|
|
83
|
+
|
|
84
|
+
5. **Move the file** if confirmed:
|
|
85
|
+
```bash
|
|
86
|
+
mv "{brain_dir}/{inbox_folder}/{file}" "{brain_dir}/{destination}/{file}"
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
6. **Clear active doc** from session
|
|
90
|
+
|
|
91
|
+
## Quick Notes
|
|
92
|
+
|
|
93
|
+
**Overrides:** brain's Notes workflow
|
|
94
|
+
|
|
95
|
+
**Steps:**
|
|
96
|
+
|
|
97
|
+
1. **Create in inbox:** `{brain_dir}/{inbox_folder}/note-{date}-{slug}.md`
|
|
98
|
+
|
|
99
|
+
2. **Use note template** with minimal frontmatter:
|
|
100
|
+
```yaml
|
|
101
|
+
---
|
|
102
|
+
type: note
|
|
103
|
+
created: {date}
|
|
104
|
+
tags: []
|
|
105
|
+
---
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
3. **Fire-and-forget** (does not become active)
|
|
109
|
+
|
|
110
|
+
## Project Integration (Optional)
|
|
111
|
+
|
|
112
|
+
**Requires:** `project` skill. If not installed, suggest:
|
|
113
|
+
> "Linking to projects requires the project skill. Install it with `droid` → Skills → project"
|
|
114
|
+
|
|
115
|
+
When a project is loaded via `/project {name}`:
|
|
116
|
+
|
|
117
|
+
1. **Remember project name** for session
|
|
118
|
+
2. **New brain docs** automatically get `project: "[[{name}]]"` in frontmatter
|
|
119
|
+
3. **Suggest linking** existing brain docs to the project
|
|
120
|
+
|
|
121
|
+
## Adding Brain Doc to Existing Project
|
|
122
|
+
|
|
123
|
+
**Trigger:** User says "add this to the project", "link this to project", or "capture in project"
|
|
124
|
+
|
|
125
|
+
**Requires:** `project` skill. If not installed, suggest:
|
|
126
|
+
> "Linking to projects requires the project skill. Install it with `droid` → Skills → project"
|
|
127
|
+
|
|
128
|
+
For linking a brain doc (research, notes, design) to an existing project.
|
|
129
|
+
|
|
130
|
+
**Steps:**
|
|
131
|
+
|
|
132
|
+
1. **Check for active project:**
|
|
133
|
+
- If project loaded via `/project`, use that
|
|
134
|
+
- Otherwise, ask which project to link to
|
|
135
|
+
|
|
136
|
+
2. **Update brain doc frontmatter:**
|
|
137
|
+
- Add `project: "[[{project-name}]]"`
|
|
138
|
+
- Update status if appropriate
|
|
139
|
+
|
|
140
|
+
3. **Update project:**
|
|
141
|
+
- Add wikilink in Related section: `[[{brain-doc}]]`
|
|
142
|
+
- Or add to appropriate section (Key Decisions, Implementation, etc.)
|
|
143
|
+
|
|
144
|
+
4. **Suggest moving brain doc:**
|
|
145
|
+
- With PARA: move to `{projects_folder}/` alongside project
|
|
146
|
+
- Without PARA: keep in place with project link
|
|
147
|
+
|
|
148
|
+
## Promoting Brain Doc to New Project
|
|
149
|
+
|
|
150
|
+
**Trigger:** User says "promote to project", "make this a project", or "convert to project"
|
|
151
|
+
|
|
152
|
+
**Requires:** `project` skill. If not installed, suggest:
|
|
153
|
+
> "Promoting to project requires the project skill. Install it with `droid` → Skills → project"
|
|
154
|
+
|
|
155
|
+
For graduating a full tech design or plan into its own project.
|
|
156
|
+
|
|
157
|
+
**Steps:**
|
|
158
|
+
|
|
159
|
+
1. **Confirm promotion:**
|
|
160
|
+
- "This will create a new project from this brain doc. Continue?"
|
|
161
|
+
|
|
162
|
+
2. **Extract project info from brain doc:**
|
|
163
|
+
- Title → project name
|
|
164
|
+
- Context → project overview
|
|
165
|
+
- Decision/Next Steps → initial tasks
|
|
166
|
+
- Status → project status
|
|
167
|
+
|
|
168
|
+
3. **Create new project** via project skill:
|
|
169
|
+
- Generate PROJECT.md from brain doc content
|
|
170
|
+
- Create CHANGELOG.md with initial entry
|
|
171
|
+
- Place in projects directory
|
|
172
|
+
|
|
173
|
+
4. **Update original brain doc:**
|
|
174
|
+
- Add `project: "[[{new-project}]]"` to frontmatter
|
|
175
|
+
- Update status to `done`
|
|
176
|
+
- Add note: "Promoted to project: [[{new-project}]]"
|
|
177
|
+
|
|
178
|
+
5. **Handle the brain doc:**
|
|
179
|
+
- Option A: Keep as historical reference in `{resources_folder}/`
|
|
180
|
+
- Option B: Archive to `{archive_folder}/`
|
|
181
|
+
- Option C: Delete (content now lives in project)
|
|
182
|
+
|
|
183
|
+
## Listing Docs
|
|
184
|
+
|
|
185
|
+
**Overrides:** brain's Listing workflow
|
|
186
|
+
|
|
187
|
+
Search in vault:
|
|
188
|
+
```
|
|
189
|
+
Glob: {brain_dir}/**/*.md
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Filter to brain doc types by checking frontmatter for `type: plan|research|review|note`.
|