@orderful/droid 0.31.1 → 0.31.2
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/.claude-plugin/marketplace.json +4 -4
- package/AGENTS.md +1 -0
- package/CHANGELOG.md +68 -0
- package/dist/tools/brain/.claude-plugin/plugin.json +1 -1
- package/dist/tools/brain/TOOL.yaml +1 -1
- package/dist/tools/brain/commands/brain.md +13 -11
- package/dist/tools/brain/commands/scratchpad.md +4 -6
- package/dist/tools/brain/skills/brain/SKILL.md +62 -105
- package/dist/tools/brain/skills/brain/references/templates.md +37 -5
- package/dist/tools/brain/skills/brain/references/workflows.md +27 -16
- package/dist/tools/brain/skills/brain-obsidian/references/workflows.md +1 -1
- package/dist/tools/codex/.claude-plugin/plugin.json +1 -1
- package/dist/tools/codex/TOOL.yaml +1 -1
- package/dist/tools/codex/commands/codex.md +15 -12
- package/dist/tools/codex/skills/codex/SKILL.md +30 -63
- package/dist/tools/codex/skills/codex/references/creating.md +2 -2
- package/dist/tools/codex/skills/codex/references/decisions.md +1 -1
- package/dist/tools/droid/.claude-plugin/plugin.json +1 -1
- package/dist/tools/droid/TOOL.yaml +1 -1
- package/dist/tools/droid/skills/droid/SKILL.md +48 -409
- package/dist/tools/project/.claude-plugin/plugin.json +1 -1
- package/dist/tools/project/TOOL.yaml +1 -1
- package/dist/tools/project/commands/project.md +12 -12
- package/dist/tools/project/skills/project/SKILL.md +12 -4
- package/dist/tools/project/skills/project/references/creating.md +2 -2
- package/dist/tools/project/skills/project/references/loading.md +17 -3
- package/dist/tools/tech-design/skills/tech-design/references/think.md +1 -1
- package/package.json +1 -1
- package/src/tools/brain/.claude-plugin/plugin.json +1 -1
- package/src/tools/brain/TOOL.yaml +1 -1
- package/src/tools/brain/commands/brain.md +13 -11
- package/src/tools/brain/commands/scratchpad.md +4 -6
- package/src/tools/brain/skills/brain/SKILL.md +62 -105
- package/src/tools/brain/skills/brain/references/templates.md +37 -5
- package/src/tools/brain/skills/brain/references/workflows.md +27 -16
- package/src/tools/brain/skills/brain-obsidian/references/workflows.md +1 -1
- package/src/tools/codex/.claude-plugin/plugin.json +1 -1
- package/src/tools/codex/TOOL.yaml +1 -1
- package/src/tools/codex/commands/codex.md +15 -12
- package/src/tools/codex/skills/codex/SKILL.md +30 -63
- package/src/tools/codex/skills/codex/references/creating.md +2 -2
- package/src/tools/codex/skills/codex/references/decisions.md +1 -1
- package/src/tools/droid/.claude-plugin/plugin.json +1 -1
- package/src/tools/droid/TOOL.yaml +1 -1
- package/src/tools/droid/skills/droid/SKILL.md +48 -409
- package/src/tools/project/.claude-plugin/plugin.json +1 -1
- package/src/tools/project/TOOL.yaml +1 -1
- package/src/tools/project/commands/project.md +12 -12
- package/src/tools/project/skills/project/SKILL.md +12 -4
- package/src/tools/project/skills/project/references/creating.md +2 -2
- package/src/tools/project/skills/project/references/loading.md +17 -3
- package/src/tools/tech-design/skills/tech-design/references/think.md +1 -1
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"name": "droid",
|
|
11
11
|
"description": "Core droid meta-skill for update awareness, tool discovery, and usage help. Checks for updates, helps users find tools, and answers 'how do I...' questions about droid workflows.",
|
|
12
|
-
"version": "0.5.
|
|
12
|
+
"version": "0.5.3",
|
|
13
13
|
"source": {
|
|
14
14
|
"source": "github",
|
|
15
15
|
"repo": "orderful/droid",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
{
|
|
23
23
|
"name": "droid-brain",
|
|
24
24
|
"description": "Your scratchpad (or brain) - a collaborative space for planning and research. Create docs with /brain plan, /brain research, or /brain review. Use @mentions for async discussion. Docs persist across sessions.",
|
|
25
|
-
"version": "0.3.
|
|
25
|
+
"version": "0.3.3",
|
|
26
26
|
"source": {
|
|
27
27
|
"source": "github",
|
|
28
28
|
"repo": "orderful/droid",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
{
|
|
62
62
|
"name": "droid-codex",
|
|
63
63
|
"description": "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries.",
|
|
64
|
-
"version": "0.1.
|
|
64
|
+
"version": "0.1.9",
|
|
65
65
|
"source": {
|
|
66
66
|
"source": "github",
|
|
67
67
|
"repo": "orderful/droid",
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
{
|
|
88
88
|
"name": "droid-project",
|
|
89
89
|
"description": "Manage project context files for persistent AI memory across sessions. Load, update, or create project context before working on multi-session features.",
|
|
90
|
-
"version": "0.3.
|
|
90
|
+
"version": "0.3.2",
|
|
91
91
|
"source": {
|
|
92
92
|
"source": "github",
|
|
93
93
|
"repo": "orderful/droid",
|
package/AGENTS.md
CHANGED
|
@@ -100,6 +100,7 @@ Things that will bite you if you don't know:
|
|
|
100
100
|
| Bump tool version when skill content changes | Users won't get updates otherwise | Patch bump the tool's TOOL.yaml version |
|
|
101
101
|
| Config-first in commands | User overrides must take precedence | Always read `~/.droid/skills/{skill}/overrides.yaml` before using defaults |
|
|
102
102
|
| Changeset package name | npm package is scoped | Use `"@orderful/droid"` not `"droid"` in changesets |
|
|
103
|
+
| Run build before PR | Plugin manifests need regenerating when tools change | Run `bun run build` and commit plugin.json files before creating PR |
|
|
103
104
|
|
|
104
105
|
## Testing
|
|
105
106
|
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,73 @@
|
|
|
1
1
|
# @orderful/droid
|
|
2
2
|
|
|
3
|
+
## 0.31.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#190](https://github.com/Orderful/droid/pull/190) [`06e1d05`](https://github.com/Orderful/droid/commit/06e1d055e774ff8f996343ca7ca771477e300f7e) Thanks [@frytyler](https://github.com/frytyler)! - Condense skill docs for better context efficiency (Phase 3)
|
|
8
|
+
|
|
9
|
+
**droid skill** (450 → 89 lines, 80% reduction):
|
|
10
|
+
- Removed verbose example dialogues
|
|
11
|
+
- Condensed to tables + guidelines
|
|
12
|
+
- LLM generates natural responses from shorter guidance
|
|
13
|
+
|
|
14
|
+
**brain skill** (191 → 128 lines, 33% reduction):
|
|
15
|
+
- User-defined categories: any non-reserved word becomes a category
|
|
16
|
+
- `/brain spike auth` → `spikes/auth.md` (creates on the fly)
|
|
17
|
+
- Reserved keywords: `search`, `add`, `check`, `done`
|
|
18
|
+
- Collapsed repetitive per-category sections into single generic pattern
|
|
19
|
+
|
|
20
|
+
**codex skill** (454 → 405 lines, 11% reduction):
|
|
21
|
+
- Collapsed `/codex new {type}` commands into single pattern
|
|
22
|
+
- `/codex new {category} {name}` where category = project|domain|proposal|pattern|topic
|
|
23
|
+
- Removed `/codex new {name}` shorthand - must specify category explicitly
|
|
24
|
+
|
|
25
|
+
**Commands updated** to match new patterns:
|
|
26
|
+
- brain, scratchpad, codex, project commands now use explicit `search` keyword
|
|
27
|
+
- Added `--` delimiter examples
|
|
28
|
+
- Added category-scoped search examples for codex
|
|
29
|
+
|
|
30
|
+
**brain_dir config:** Removed default - now prompts user to choose location on first use.
|
|
31
|
+
|
|
32
|
+
**Reference files updated** to match Phase 1-3 changes:
|
|
33
|
+
- brain/references/workflows.md - explicit `search`, user-defined categories
|
|
34
|
+
- brain-obsidian/references/workflows.md - explicit search patterns
|
|
35
|
+
- codex/references/creating.md, decisions.md - explicit search patterns
|
|
36
|
+
- project/references/loading.md, creating.md - explicit search patterns, `--` delimiter examples
|
|
37
|
+
|
|
38
|
+
**Total savings:** ~470 lines removed across three skills. Smaller docs = more context for actual work.
|
|
39
|
+
|
|
40
|
+
- [#189](https://github.com/Orderful/droid/pull/189) [`d9917c4`](https://github.com/Orderful/droid/commit/d9917c4630ac5c418d31a332b3114500bfa78fa3) Thanks [@frytyler](https://github.com/frytyler)! - Add search enhancements: `--` delimiter and category-scoped search
|
|
41
|
+
|
|
42
|
+
**`--` delimiter for follow-up instructions** (brain, codex, project):
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
/brain search auth refactor -- what's left to do?
|
|
46
|
+
/project search droid -- show the changelog
|
|
47
|
+
/codex search transaction -- summarize the PRD
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Everything after `--` is executed as a follow-up instruction after loading the doc.
|
|
51
|
+
|
|
52
|
+
**Category-scoped search for codex**:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
/codex topics search auth # Search within topics only
|
|
56
|
+
/codex patterns search webhook # Search within patterns only
|
|
57
|
+
/codex projects search transaction
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Narrows search to a specific category instead of searching all categories.
|
|
61
|
+
|
|
62
|
+
- [#187](https://github.com/Orderful/droid/pull/187) [`738bcec`](https://github.com/Orderful/droid/commit/738bcec4ffbe8ad5bff6a986838bf26fd6b6544a) Thanks [@frytyler](https://github.com/frytyler)! - Require explicit `search` keyword for /codex, /brain, and /project commands
|
|
63
|
+
|
|
64
|
+
Commands that support both reserved keywords and search had ambiguity issues (e.g., `/codex projects` - is this "list projects" or "search for 'projects'"?). This change removes implicit search patterns and requires the explicit `search` keyword:
|
|
65
|
+
- `/codex search {query}` (was `/codex {name}`)
|
|
66
|
+
- `/brain search {topic}` (was `/brain {topic}`)
|
|
67
|
+
- `/project search {keywords}` (was `/project {keywords}`)
|
|
68
|
+
|
|
69
|
+
Closes #139
|
|
70
|
+
|
|
3
71
|
## 0.31.1
|
|
4
72
|
|
|
5
73
|
### Patch Changes
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "droid-brain",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"description": "Your scratchpad (or brain) - a collaborative space for planning and research. Create docs with /brain plan, /brain research, or /brain review. Use @mentions for async discussion. Docs persist across sessions.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Orderful",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
name: brain
|
|
2
2
|
description: "Your scratchpad (or brain) - a collaborative space for planning and research. Create docs with /brain plan, /brain research, or /brain review. Use @mentions for async discussion. Docs persist across sessions."
|
|
3
|
-
version: 0.3.
|
|
3
|
+
version: 0.3.3
|
|
4
4
|
status: beta
|
|
5
5
|
|
|
6
6
|
includes:
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: brain
|
|
3
3
|
description: "Collaborative scratchpad for planning and research"
|
|
4
|
-
argument-hint: "[{topic} |
|
|
4
|
+
argument-hint: "[search {topic} | {category} {topic} | add {text} | check | done]"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /brain
|
|
@@ -14,20 +14,22 @@ argument-hint: "[{topic} | plan|research|review {topic} | idea|add {text} | chec
|
|
|
14
14
|
|
|
15
15
|
## Examples
|
|
16
16
|
|
|
17
|
-
- `/brain auth-refactor` → Search for existing doc about "auth-refactor"
|
|
18
|
-
- `/brain
|
|
19
|
-
- `/brain
|
|
17
|
+
- `/brain search auth-refactor` → Search for existing doc about "auth-refactor"
|
|
18
|
+
- `/brain search droid -- what's left to do?` → Search, load, then answer question
|
|
19
|
+
- `/brain plan new-feature` → Create a new planning doc
|
|
20
|
+
- `/brain spike caching` → Create doc in custom category → `spikes/caching.md`
|
|
21
|
+
- `/brain add found a bug` → Append text to active doc
|
|
20
22
|
|
|
21
23
|
## Quick Reference
|
|
22
24
|
|
|
23
25
|
```
|
|
24
|
-
/brain {topic}
|
|
25
|
-
/brain
|
|
26
|
-
/brain
|
|
27
|
-
/brain
|
|
28
|
-
/brain check
|
|
26
|
+
/brain search {topic} # Search for existing doc
|
|
27
|
+
/brain search {topic} -- {q} # Search, load, then execute follow-up
|
|
28
|
+
/brain {category} {topic} # Create doc → {category}s/{topic}.md
|
|
29
|
+
/brain add {text} # Append to active doc
|
|
30
|
+
/brain check # Address @droid comments
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
**
|
|
33
|
+
**Reserved keywords:** `search`, `add`, `check`, `done` - everything else is a category.
|
|
32
34
|
|
|
33
|
-
See the **brain skill** for complete documentation
|
|
35
|
+
See the **brain skill** for complete documentation.
|
|
@@ -11,18 +11,16 @@ description: "Alias for brain. See brain skill for full behavior."
|
|
|
11
11
|
|
|
12
12
|
## Examples
|
|
13
13
|
|
|
14
|
-
- `/scratchpad auth-refactor` → Search for existing doc
|
|
15
|
-
- `/scratchpad plan new-feature` → Create a new planning doc
|
|
14
|
+
- `/scratchpad search auth-refactor` → Search for existing doc
|
|
15
|
+
- `/scratchpad plan new-feature` → Create a new planning doc
|
|
16
16
|
|
|
17
17
|
## Quick Reference
|
|
18
18
|
|
|
19
19
|
Same as `/brain` - use whichever name feels natural:
|
|
20
20
|
|
|
21
21
|
```
|
|
22
|
-
/scratchpad {topic}
|
|
23
|
-
/scratchpad
|
|
22
|
+
/scratchpad search {topic} # Search for existing doc
|
|
23
|
+
/scratchpad {category} {topic} # Create doc
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
**Default behavior:** SEARCH first, don't create unless plan/research/review keyword is present.
|
|
27
|
-
|
|
28
26
|
See `/brain` or the **brain skill** for complete documentation.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: brain
|
|
3
3
|
description: "Collaborative scratchpad for planning and research. Use when planning a feature, exploring a problem, or capturing thinking that should persist across sessions. User prompts like 'let's think through', 'open a scratchpad', 'plan this out', 'use our brain'."
|
|
4
|
-
argument-hint: "[{topic} |
|
|
4
|
+
argument-hint: "[search {topic} | {category} {topic} | add {text} | check | done]"
|
|
5
5
|
allowed-tools: [Read, Write, Glob, Grep, Bash]
|
|
6
6
|
---
|
|
7
7
|
|
|
@@ -11,21 +11,12 @@ Your **scratchpad** (or **brain**) - a collaborative space for planning, researc
|
|
|
11
11
|
|
|
12
12
|
> **Alias:** All `/brain` commands also work as `/scratchpad` - use whichever feels natural.
|
|
13
13
|
|
|
14
|
-
## Why Brain Docs?
|
|
15
|
-
|
|
16
|
-
Ideas develop through iteration, not single prompts.
|
|
17
|
-
|
|
18
|
-
- **Thinking space** - Work through problems before committing to code
|
|
19
|
-
- **Async collaboration** - Leave `@mentions` for discussion across sessions (see comments skill for full support)
|
|
20
|
-
- **Persistent context** - Docs survive after chat history disappears
|
|
21
|
-
|
|
22
14
|
## When to Use
|
|
23
15
|
|
|
24
16
|
- Planning implementation for a feature
|
|
25
17
|
- Researching a problem or technology
|
|
26
18
|
- Design work that benefits from written iteration
|
|
27
19
|
- User says "brain", "scratchpad", "let's think through", "plan this out"
|
|
28
|
-
- Optionally, to capture output from plan mode sessions
|
|
29
20
|
|
|
30
21
|
## When NOT to Use
|
|
31
22
|
|
|
@@ -35,110 +26,86 @@ Ideas develop through iteration, not single prompts.
|
|
|
35
26
|
|
|
36
27
|
## Configuration
|
|
37
28
|
|
|
38
|
-
**IMPORTANT:**
|
|
39
|
-
|
|
40
|
-
| Setting | Default | Description |
|
|
41
|
-
| -------------- | ----------- | ------------------------------------------ |
|
|
42
|
-
| `brain_dir` | (see below) | Where docs are stored |
|
|
43
|
-
| `inbox_folder` | (empty) | Root folder for new docs (e.g., `0-Inbox`) |
|
|
44
|
-
|
|
45
|
-
Default `brain_dir` by AI tool (only if not configured):
|
|
29
|
+
**IMPORTANT:** Read `~/.droid/skills/brain/overrides.yaml` first. If `brain_dir` is not configured, **ask the user** where they want brain docs stored.
|
|
46
30
|
|
|
47
|
-
|
|
48
|
-
|
|
31
|
+
| Setting | Default | Description |
|
|
32
|
+
| -------------- | ------- | ------------------------------------------ |
|
|
33
|
+
| `brain_dir` | (none) | Where docs are stored - **must be configured** |
|
|
34
|
+
| `inbox_folder` | (empty) | Root folder for new docs (e.g., `0-Inbox`) |
|
|
49
35
|
|
|
50
|
-
|
|
36
|
+
**If not configured:** Ask the user:
|
|
37
|
+
> "Where would you like to store brain docs? Common choices:
|
|
38
|
+
> - `~/Documents/brain` - Easy to find in Finder
|
|
39
|
+
> - `~/src/github.com/brain` - With your other repos
|
|
40
|
+
> - An existing Obsidian vault path"
|
|
51
41
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
{brain_dir}/
|
|
56
|
-
└── {inbox_folder}/ # e.g., "0-Inbox" (or root if not set)
|
|
57
|
-
├── plans/ # Structured planning docs
|
|
58
|
-
├── research/ # Open-ended exploration
|
|
59
|
-
├── reviews/ # Code reviews, evaluations
|
|
60
|
-
└── ideas/ # Quick captures
|
|
42
|
+
Then write their choice to `~/.droid/skills/brain/overrides.yaml`:
|
|
43
|
+
```yaml
|
|
44
|
+
brain_dir: "{user's choice}"
|
|
61
45
|
```
|
|
62
46
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
## Core Concepts
|
|
47
|
+
## Commands
|
|
66
48
|
|
|
67
|
-
**
|
|
49
|
+
**Reserved keywords:** `search`, `add`, `check`, `done`
|
|
68
50
|
|
|
69
|
-
|
|
51
|
+
| Command | Action |
|
|
52
|
+
| -------------------------------------------- | ------------------------------------------------------ |
|
|
53
|
+
| `/brain` | List recent docs or create new |
|
|
54
|
+
| `/brain search {topic}` | Search for existing doc (fuzzy match) → becomes active |
|
|
55
|
+
| `/brain search {topic} -- {instruction}` | Search, load, then execute follow-up instruction |
|
|
56
|
+
| `/brain {category} {topic}` | Create doc → `{category}s/{topic}.md` |
|
|
57
|
+
| `/brain add {text}` | Append to active doc |
|
|
58
|
+
| `/brain check` | Address @droid comments in active doc |
|
|
59
|
+
| `/brain done` | Finalize active doc, update status |
|
|
70
60
|
|
|
61
|
+
**Category is any non-reserved word.** Common categories:
|
|
71
62
|
- `plan` → `plans/` - Structured: Context → Exploration → Decision → Next Steps
|
|
72
|
-
- `research` → `research/` - Open-ended exploration
|
|
73
|
-
- `review` → `reviews/` - Code review,
|
|
74
|
-
- `idea` → `ideas/` - Quick
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
Example conversation:
|
|
84
|
-
|
|
85
|
-
```markdown
|
|
86
|
-
> @droid Should we add caching here?
|
|
87
|
-
|
|
88
|
-
> @fry Yes, Redis would work well for this use case.
|
|
63
|
+
- `research` → `research/` - Open-ended exploration
|
|
64
|
+
- `review` → `reviews/` - Code review, evaluations
|
|
65
|
+
- `idea` → `ideas/` - Quick captures
|
|
66
|
+
|
|
67
|
+
But users can create any category on the fly:
|
|
68
|
+
```bash
|
|
69
|
+
/brain spike auth-caching → spikes/auth-caching.md
|
|
70
|
+
/brain meeting standup-jan-17 → meetings/standup-jan-17.md
|
|
71
|
+
/brain design api-v2 → designs/api-v2.md
|
|
72
|
+
/brain retro q4-launch → retros/q4-launch.md
|
|
89
73
|
```
|
|
90
74
|
|
|
91
|
-
Read user's configured mention from `~/.droid/config.yaml` → `user_mention` (e.g., `@fry`). If droid's `comments` skill is installed, use `/comments check` for full support.
|
|
92
|
-
|
|
93
|
-
**Status lifecycle:** `exploring` → `drafting` → `decided` → `done`
|
|
94
|
-
|
|
95
|
-
## Commands
|
|
96
|
-
|
|
97
|
-
| Command | Action |
|
|
98
|
-
| ------------------------- | ---------------------------------------------------------- |
|
|
99
|
-
| `/brain` | List recent docs or create new |
|
|
100
|
-
| `/brain {topic}` | **Search** for existing doc (fuzzy match) → becomes active |
|
|
101
|
-
| `/brain plan {topic}` | Create planning doc → `plans/{topic}.md` |
|
|
102
|
-
| `/brain research {topic}` | Create research doc → `research/{topic}.md` |
|
|
103
|
-
| `/brain review {topic}` | Create review doc → `reviews/{topic}.md` |
|
|
104
|
-
| `/brain idea {text}` | Quick capture → `ideas/{date}-{slug}.md` (not active) |
|
|
105
|
-
| `/brain add {text}` | Append to active doc |
|
|
106
|
-
| `/brain check` | Address @droid comments in active doc |
|
|
107
|
-
| `/brain done` | Finalize active doc, update status |
|
|
108
|
-
|
|
109
|
-
**IMPORTANT:** The default action for `/brain {topic}` is to **SEARCH** for existing docs, NOT create. Only use `/brain plan {topic}` or `/brain research {topic}` when the user explicitly wants to create a new doc.
|
|
110
|
-
|
|
111
75
|
## Opening a Doc
|
|
112
76
|
|
|
113
|
-
**Trigger:** `/brain {topic}` or user asks to open a brain doc
|
|
77
|
+
**Trigger:** `/brain search {topic}` or user asks to open a brain doc
|
|
114
78
|
|
|
115
|
-
|
|
79
|
+
Search for and open an existing doc. Fuzzy-match topic against existing docs, read content, set as active.
|
|
80
|
+
|
|
81
|
+
**Follow-up instructions:** Use `--` to add an instruction to execute after loading:
|
|
82
|
+
```bash
|
|
83
|
+
/brain search auth refactor -- what's left to do?
|
|
84
|
+
/brain search droid plans -- summarize the decisions
|
|
85
|
+
```
|
|
116
86
|
|
|
117
87
|
Full procedure: `references/workflows.md` § Opening
|
|
118
88
|
|
|
119
89
|
## Creating a Doc
|
|
120
90
|
|
|
121
|
-
**Trigger:** `/brain
|
|
122
|
-
|
|
123
|
-
**TLDR:** Create doc from template, set as active, gather initial context.
|
|
124
|
-
|
|
125
|
-
Full procedure: `references/workflows.md` § Creating
|
|
126
|
-
Templates: `references/templates.md`
|
|
127
|
-
Naming: `references/naming.md`
|
|
91
|
+
**Trigger:** `/brain {category} {topic}`
|
|
128
92
|
|
|
129
|
-
|
|
93
|
+
1. Parse first arg - if not a reserved keyword, it's the category
|
|
94
|
+
2. Pluralize category for folder name (add 's')
|
|
95
|
+
3. Create `{brain_dir}/{inbox_folder}/{category}s/{topic}.md` from template
|
|
96
|
+
4. Set as active doc for the session
|
|
130
97
|
|
|
131
|
-
|
|
98
|
+
Templates vary by category (see `references/templates.md`), but all follow the same creation flow.
|
|
132
99
|
|
|
133
|
-
**
|
|
100
|
+
**Note:** `idea` category docs do NOT become active (fire-and-forget capture).
|
|
134
101
|
|
|
135
|
-
Full procedure: `references/workflows.md` §
|
|
102
|
+
Full procedure: `references/workflows.md` § Creating
|
|
136
103
|
|
|
137
104
|
## Adding Content
|
|
138
105
|
|
|
139
106
|
**Trigger:** `/brain add {text}`
|
|
140
107
|
|
|
141
|
-
|
|
108
|
+
Append text to active doc with timestamp.
|
|
142
109
|
|
|
143
110
|
Full procedure: `references/workflows.md` § Adding
|
|
144
111
|
|
|
@@ -146,7 +113,7 @@ Full procedure: `references/workflows.md` § Adding
|
|
|
146
113
|
|
|
147
114
|
**Trigger:** `/brain check`
|
|
148
115
|
|
|
149
|
-
|
|
116
|
+
Find `> @droid` comments in active doc and address each. Preserve original comment, add response below with `> @{user_mention}`.
|
|
150
117
|
|
|
151
118
|
Full procedure: `references/workflows.md` § Checking
|
|
152
119
|
|
|
@@ -154,29 +121,19 @@ Full procedure: `references/workflows.md` § Checking
|
|
|
154
121
|
|
|
155
122
|
**Trigger:** `/brain done`
|
|
156
123
|
|
|
157
|
-
|
|
124
|
+
Review doc, update status to `done`, suggest next steps.
|
|
158
125
|
|
|
159
126
|
Full procedure: `references/workflows.md` § Finalizing
|
|
160
127
|
|
|
161
|
-
##
|
|
162
|
-
|
|
163
|
-
Before creating or modifying brain docs, check if any `brain-*` extension skills are installed:
|
|
164
|
-
|
|
165
|
-
```
|
|
166
|
-
# Claude Code
|
|
167
|
-
~/.claude/skills/brain-*/SKILL.md
|
|
128
|
+
## Comment Conventions
|
|
168
129
|
|
|
169
|
-
|
|
170
|
-
~/.config/opencode/skills/brain-*/SKILL.md
|
|
130
|
+
In markdown files, use blockquote `>` prefix for @mention comments:
|
|
171
131
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
```
|
|
132
|
+
- `> @droid` - **User** leaves comment for AI to address
|
|
133
|
+
- `> @{user}` - **AI** leaves comment for user
|
|
175
134
|
|
|
176
|
-
|
|
135
|
+
Get `user_mention` from `droid config brain`. If droid's `comments` skill is installed, use `/comments check` for full support.
|
|
177
136
|
|
|
178
|
-
|
|
179
|
-
- Folder organization (PARA structure)
|
|
180
|
-
- Additional commands or integrations
|
|
137
|
+
## Extensions
|
|
181
138
|
|
|
182
|
-
|
|
139
|
+
Check for `brain-*` extension skills in `~/.claude/skills/`, `~/.config/opencode/skills/`, or `~/.droid/skills/`. If found, use extension's templates and workflows instead of defaults.
|
|
@@ -1,8 +1,40 @@
|
|
|
1
1
|
# Brain Doc Templates
|
|
2
2
|
|
|
3
|
-
Templates for
|
|
3
|
+
Templates for brain docs. Use the **Generic Template** for user-defined categories.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Generic Template (for any category)
|
|
6
|
+
|
|
7
|
+
Use this for user-defined categories like `spike`, `meeting`, `design`, `retro`, etc.
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
# {Topic}
|
|
11
|
+
|
|
12
|
+
**Type:** {category}
|
|
13
|
+
**Status:** active
|
|
14
|
+
**Created:** {date}
|
|
15
|
+
|
|
16
|
+
{Brief description based on category and topic}.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
|
|
20
|
+
{Content area - adapt sections based on what makes sense for this category}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The AI should adapt the sections based on the category name:
|
|
24
|
+
- `spike` → Background, Findings, Conclusion
|
|
25
|
+
- `meeting` → Attendees, Discussion, Action Items
|
|
26
|
+
- `design` → Context, Proposal, Trade-offs
|
|
27
|
+
- `retro` → What Went Well, What Didn't, Actions
|
|
28
|
+
|
|
29
|
+
Keep it simple - start with minimal structure and let the user expand.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Common Category Templates
|
|
34
|
+
|
|
35
|
+
These templates are for the most common categories. For any other category, use the Generic Template above.
|
|
36
|
+
|
|
37
|
+
### Plan Template
|
|
6
38
|
|
|
7
39
|
```markdown
|
|
8
40
|
# {Topic}
|
|
@@ -30,7 +62,7 @@ What we chose and why.
|
|
|
30
62
|
- [ ] Action items
|
|
31
63
|
```
|
|
32
64
|
|
|
33
|
-
|
|
65
|
+
### Research Template
|
|
34
66
|
|
|
35
67
|
```markdown
|
|
36
68
|
# {Topic}
|
|
@@ -54,7 +86,7 @@ What we've learned.
|
|
|
54
86
|
Key takeaways.
|
|
55
87
|
```
|
|
56
88
|
|
|
57
|
-
|
|
89
|
+
### Review Template
|
|
58
90
|
|
|
59
91
|
```markdown
|
|
60
92
|
# {Topic}
|
|
@@ -82,7 +114,7 @@ Suggested changes or actions.
|
|
|
82
114
|
Overall assessment.
|
|
83
115
|
```
|
|
84
116
|
|
|
85
|
-
|
|
117
|
+
### Idea Template
|
|
86
118
|
|
|
87
119
|
```markdown
|
|
88
120
|
# {Brief Title}
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
Detailed procedures for each brain operation.
|
|
4
4
|
|
|
5
|
-
## Opening
|
|
5
|
+
## Searching / Opening
|
|
6
6
|
|
|
7
|
-
**Trigger:** `/brain {topic}` or
|
|
7
|
+
**Trigger:** `/brain search {topic}` or `/brain search {topic} -- {instruction}`
|
|
8
8
|
|
|
9
9
|
**Steps:**
|
|
10
10
|
|
|
11
11
|
1. **Read config first (MANDATORY)**
|
|
12
12
|
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
13
13
|
- If file exists and contains `brain_dir:`, use that path
|
|
14
|
-
-
|
|
14
|
+
- If `brain_dir` is not configured, **ask the user** where they want brain docs stored
|
|
15
15
|
- **Do NOT skip this step or assume defaults**
|
|
16
16
|
|
|
17
17
|
2. **Search for matches**
|
|
@@ -35,9 +35,15 @@ Detailed procedures for each brain operation.
|
|
|
35
35
|
|
|
36
36
|
5. **Set as active doc** - Remember path for subsequent `/brain add` and `/brain check` commands
|
|
37
37
|
|
|
38
|
+
6. **If `-- {instruction}` provided:** Execute the follow-up instruction against the loaded doc
|
|
39
|
+
|
|
38
40
|
## Creating
|
|
39
41
|
|
|
40
|
-
**Trigger:** `/brain
|
|
42
|
+
**Trigger:** `/brain {category} {topic}` - where category is any non-reserved word
|
|
43
|
+
|
|
44
|
+
**Reserved keywords:** `search`, `add`, `check`, `done` - everything else is a category.
|
|
45
|
+
|
|
46
|
+
**Common categories:** `plan`, `research`, `review`, `idea`, `spike`, `meeting`, `design`, `retro`
|
|
41
47
|
|
|
42
48
|
**Steps:**
|
|
43
49
|
|
|
@@ -45,22 +51,27 @@ Detailed procedures for each brain operation.
|
|
|
45
51
|
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
46
52
|
- If file exists and contains `brain_dir:`, use that path
|
|
47
53
|
- Also check for `inbox_folder` setting (e.g., `0-Inbox`)
|
|
48
|
-
-
|
|
54
|
+
- If `brain_dir` is not configured, **ask the user** where they want brain docs stored
|
|
49
55
|
- **Do NOT skip this step or assume defaults**
|
|
50
56
|
|
|
51
57
|
2. **Generate filename** using naming conventions (see `naming.md`):
|
|
52
58
|
- Format: `{topic-slug}.md` (no type prefix - folder indicates type)
|
|
53
59
|
- Example: `auth-refactor.md` or `caching-strategies.md`
|
|
54
60
|
|
|
55
|
-
3. **Determine target path based on
|
|
61
|
+
3. **Determine target path based on category:**
|
|
56
62
|
- Base: `{brain_dir}/{inbox_folder}` (or just `{brain_dir}` if no inbox_folder)
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
|
|
63
|
+
- Category becomes plural folder: `{base}/{category}s/{filename}`
|
|
64
|
+
- Examples:
|
|
65
|
+
- `plan` → `{base}/plans/{filename}`
|
|
66
|
+
- `research` → `{base}/research/{filename}`
|
|
67
|
+
- `spike` → `{base}/spikes/{filename}`
|
|
68
|
+
- `meeting` → `{base}/meetings/{filename}`
|
|
60
69
|
|
|
61
|
-
4. **Create directory** if needed (
|
|
70
|
+
4. **Create directory** if needed (category folder may not exist yet)
|
|
62
71
|
|
|
63
|
-
5. **Apply template** based on
|
|
72
|
+
5. **Apply template** based on category (see `templates.md`):
|
|
73
|
+
- Use common category templates for `plan`, `research`, `review`, `idea`
|
|
74
|
+
- Use generic template for user-defined categories, adapting sections based on category name
|
|
64
75
|
|
|
65
76
|
6. **Gather initial context** from conversation:
|
|
66
77
|
- What problem are we solving?
|
|
@@ -68,7 +79,7 @@ Detailed procedures for each brain operation.
|
|
|
68
79
|
- Related work or prior decisions?
|
|
69
80
|
|
|
70
81
|
7. **Add placeholder comments** for sections needing user input:
|
|
71
|
-
-
|
|
82
|
+
- Get `user_mention` from config: `droid config brain | grep user_mention`
|
|
72
83
|
- Use `> @{user_mention}` for placeholders (e.g., `> @fry - Please provide requirements`)
|
|
73
84
|
- **CRITICAL:** NEVER use `@droid` - that's for user-to-AI comments, not AI-to-user
|
|
74
85
|
|
|
@@ -80,7 +91,7 @@ Detailed procedures for each brain operation.
|
|
|
80
91
|
|
|
81
92
|
## Ideas
|
|
82
93
|
|
|
83
|
-
**Trigger:** `/brain idea {
|
|
94
|
+
**Trigger:** `/brain idea {topic}` (idea is a category like any other)
|
|
84
95
|
|
|
85
96
|
**Steps:**
|
|
86
97
|
|
|
@@ -88,7 +99,7 @@ Detailed procedures for each brain operation.
|
|
|
88
99
|
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
89
100
|
- If file exists and contains `brain_dir:`, use that path
|
|
90
101
|
- Also check for `inbox_folder` setting (e.g., `0-Inbox`)
|
|
91
|
-
-
|
|
102
|
+
- If `brain_dir` is not configured, **ask the user** where they want brain docs stored
|
|
92
103
|
- **Do NOT skip this step or assume defaults**
|
|
93
104
|
|
|
94
105
|
2. **Generate filename:**
|
|
@@ -158,7 +169,7 @@ Detailed procedures for each brain operation.
|
|
|
158
169
|
5. **For each comment:**
|
|
159
170
|
- Show the comment and surrounding context
|
|
160
171
|
- Address the question/request
|
|
161
|
-
- Add response as blockquote with user's mention: `> @{user_mention} Your response here`
|
|
172
|
+
- Add response as blockquote with user's mention (from `droid config brain`): `> @{user_mention} Your response here`
|
|
162
173
|
- Example: `> @fry Yes, the index covers that query pattern.`
|
|
163
174
|
- **CRITICAL:** NEVER use `@droid` in your responses. Use `@{user_mention}` from config (e.g., `@fry`)
|
|
164
175
|
- **CRITICAL:** Always include the `>` prefix to maintain blockquote formatting
|
|
@@ -202,7 +213,7 @@ Detailed procedures for each brain operation.
|
|
|
202
213
|
1. **Read config first (MANDATORY)**
|
|
203
214
|
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
204
215
|
- If file exists and contains `brain_dir:`, use that path
|
|
205
|
-
-
|
|
216
|
+
- If `brain_dir` is not configured, **ask the user** where they want brain docs stored
|
|
206
217
|
- **Do NOT skip this step or assume defaults**
|
|
207
218
|
|
|
208
219
|
2. **Find recent docs:**
|
|
@@ -119,7 +119,7 @@ When modifying any brain doc:
|
|
|
119
119
|
|
|
120
120
|
> "Linking to projects requires the project skill. Install it with `droid` → Skills → project"
|
|
121
121
|
|
|
122
|
-
When a project is loaded via `/project {name}`:
|
|
122
|
+
When a project is loaded via `/project search {name}`:
|
|
123
123
|
|
|
124
124
|
1. **Remember project name** for session
|
|
125
125
|
2. **New brain docs** automatically get `project: "[[{name}]]"` in frontmatter
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "droid-codex",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.9",
|
|
4
4
|
"description": "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Orderful",
|