@orderful/droid 0.6.0 → 0.8.0

package/src/skills/brain/references/workflows.md

@@ -0,0 +1,198 @@
+# Brain Workflows
+
+Detailed procedures for each brain operation.
+
+## Opening
+
+**Trigger:** `/brain {topic}` or user asks to open a brain doc
+
+**Steps:**
+
+1. **Read config first**
+   - Read `~/.droid/skills/brain/overrides.yaml`
+   - Use `brain_dir` if configured, otherwise use default for current AI tool
+
+2. **Search for matches**
+   ```
+   Glob: {brain_dir}/**/*{topic}*.md
+   ```
+   Fuzzy match the topic against doc filenames
+
+3. **Handle results:**
+   - **No matches**: Offer to create a new doc with that topic
+   - **One match**: Open it
+   - **Multiple matches**: Present list, let user choose
+
+4. **Read the doc** and summarize key points:
+   - Current status
+   - Main topic/context
+   - Any open `@droid` comments
+   - Recent updates
+
+5. **Set as active doc** - Remember path for subsequent `/brain add` and `/brain check` commands
+
+## Creating
+
+**Trigger:** `/brain plan {topic}` or `/brain research {topic}`
+
+**Steps:**
+
+1. **Read config first**
+   - Read `~/.droid/skills/brain/overrides.yaml`
+   - Use `brain_dir` if configured, otherwise use default for current AI tool
+   - Use `inbox_folder` if configured
+
+2. **Generate filename** using naming conventions (see `naming.md`):
+   - Format: `{type}-{topic-slug}.md`
+   - Example: `plan-auth-refactor.md` or `research-caching-strategies.md`
+
+3. **Determine target path:**
+   - If `inbox_folder` is set: `{brain_dir}/{inbox_folder}/{filename}`
+   - Otherwise: `{brain_dir}/{filename}`
+
+4. **Create directory** if needed
+
+5. **Apply template** based on preset and type (see `templates.md`)
+
+6. **Gather initial context** from conversation:
+   - What problem are we solving?
+   - Any constraints or requirements mentioned?
+   - Related work or prior decisions?
+
+7. **Write the doc** with template structure and initial context
+
+8. **Set as active doc**
+
+9. **Confirm creation** and summarize what was captured
+
+## Notes
+
+**Trigger:** `/brain note {text}`
+
+**Steps:**
+
+1. **Read config first**
+   - Read `~/.droid/skills/brain/overrides.yaml`
+   - Use `brain_dir` if configured, otherwise use default for current AI tool
+   - Use `inbox_folder` if configured
+
+2. **Generate filename:**
+   - Format: `note-{date}-{slug}.md` where date is `YYYYMMDD`
+   - Slug from first few words of text
+   - Example: `note-20250115-remember-rate-limits.md`
+
+3. **Determine target path:**
+   - If `inbox_folder` is set: `{brain_dir}/{inbox_folder}/{filename}`
+   - Otherwise: `{brain_dir}/{filename}`
+
+4. **Create simple note:**
+   - Markdown preset: Just the text
+   - Obsidian preset: Add frontmatter with `type: note`, `created: {date}`
+
+5. **Write the file** - Do NOT set as active (fire-and-forget)
+
+6. **Confirm** briefly: "Captured note to {filename}"
+
+## Adding
+
+**Trigger:** `/brain add {text}`
+
+**Steps:**
+
+1. **Check for active doc**
+   - If no active doc: Ask user which doc to add to, or offer to create new
+
+2. **Read current content** of active doc
+
+3. **Append new section:**
+   ```markdown
+
+   ---
+
+   ## Update ({date})
+
+   {text}
+   ```
+
+4. **Update the `updated` date** in frontmatter (if using obsidian preset)
+
+5. **Write changes**
+
+6. **Confirm** what was added
+
+## Checking
+
+**Trigger:** `/brain check`
+
+**Prefer `comments` skill:** If the `comments` skill is installed, use `/comments check` instead - it provides better comment detection, cleanup workflows, and supports the full `@droid`/`@user` convention. The workflow below is a fallback for basic comment handling.
+
+**Steps:**
+
+1. **Check for active doc**
+   - If no active doc: Ask user which doc to check, or list docs with comments
+
+2. **Read active doc**
+
+3. **Find all `> @droid` comments**
+   - Pattern: Lines starting with `> @droid` (blockquote with mention)
+
+4. **For each comment:**
+   - Show the comment and surrounding context
+   - Address the question/request
+   - Add response as `> @{user_mention}` reply
+   - Or resolve inline if it was a simple note
+
+5. **Update the doc** with responses
+
+6. **Summarize** what was addressed
+
+## Finalizing
+
+**Trigger:** `/brain done`
+
+**Steps:**
+
+1. **Check for active doc**
+   - If no active doc: Ask which doc to finalize
+
+2. **Read active doc**
+
+3. **Review content:**
+   - Are there unresolved `@droid` comments?
+   - Is there a clear decision/outcome?
+   - Any loose ends?
+
+4. **Update status** to `done` in frontmatter (obsidian preset) or add "Status: Done" (markdown preset)
+
+5. **Suggest next steps:**
+   - Promote to project? (if substantial work)
+   - Archive? (if complete)
+   - Create follow-up tasks?
+
+6. **Clear active doc** from session
+
+## Listing
+
+**Trigger:** `/brain` (no arguments)
+
+**Steps:**
+
+1. **Read config first**
+   - Read `~/.droid/skills/brain/overrides.yaml`
+   - Use `brain_dir` if configured, otherwise use default for current AI tool
+
+2. **Find recent docs:**
+   ```
+   Glob: {brain_dir}/**/*.md
+   ```
+   Sort by modification time, limit to 10-15
+
+3. **Present list** with:
+   - Filename
+   - Type (plan/research/note)
+   - Status (if available)
+   - Last modified
+
+4. **Offer options:**
+   - Select a doc to open
+   - Create new plan/research doc

package/src/skills/brain-obsidian/SKILL.md

@@ -0,0 +1,108 @@
+---
+name: brain-obsidian
+description: >-
+  Obsidian extension for brain skill. Adds YAML frontmatter, wikilinks, and folder
+  organization. Requires brain skill. Install this to use brain docs with your
+  Obsidian vault.
+globs:
+  - "**/brain/**/*.md"
+alwaysApply: false
+---
+
+# Brain Obsidian Extension
+
+Extends the brain skill with Obsidian-specific features. **This skill overrides brain's default templates and workflows.**
+
+## Requirements
+
+- `brain` skill must be installed
+- Set `brain_dir` to your Obsidian vault path in brain skill overrides
+
+## Configuration
+
+**Required:** Set vault path in `~/.droid/skills/brain/overrides.yaml`:
+
+```yaml
+brain_dir: ~/path/to/your/vault
+```
+
+**Optional:** Configure folders in `~/.droid/skills/brain-obsidian/overrides.yaml`:
+
+| Setting            | Default       | Description                     |
+|--------------------|---------------|---------------------------------|
+| `inbox_folder`     | `0-Inbox`     | Where new docs are created      |
+| `archive_folder`   | `4-Archives`  | Where stale/done docs go        |
+| `para_structure`   | `false`       | Enable full PARA organization   |
+| `projects_folder`  | `1-Projects`  | Active project docs (PARA only) |
+| `areas_folder`     | `1-Areas`     | Area docs (PARA only)           |
+| `resources_folder` | `3-Resources` | Reference material (PARA only)  |
+
+## What This Adds
+
+| Feature             | Description                                |
+|---------------------|--------------------------------------------|
+| YAML frontmatter    | Type, status, dates, project links, tags   |
+| Wikilinks           | `[[note-name]]` syntax for linking         |
+| Folder organization | Inbox + Archive always; full PARA optional |
+| Project linking     | Associate brain docs with project files    |
+
+## Folder Organization
+
+**Always available:**
+- `inbox_folder` - New docs land here
+- `archive_folder` - Stale/completed docs
+
+**With `para_structure: true`:**
+```
+vault/
+├── {inbox_folder}/      # New docs (default: 0-Inbox)
+├── {projects_folder}/   # Active project docs (default: 1-Projects)
+├── {areas_folder}/      # Area docs (default: 2-Areas)
+├── {resources_folder}/  # Reference material (default: 3-Resources)
+└── {archive_folder}/    # Completed/stale (default: 4-Archives)
+```
+
+## Overridden Behavior
+
+When this skill is installed, **ALL brain operations use Obsidian format**:
+
+### Templates
+
+All docs get YAML frontmatter:
+
+```yaml
+---
+type: plan | research | review | note
+status: exploring | drafting | decided | done
+created: YYYY-MM-DD
+updated: YYYY-MM-DD
+project: "[[project-name]]"  # Optional
+tags: []                      # Optional
+---
+```
+
+See `references/templates.md` for full templates.
+
+### File Location
+
+Docs are created in your vault's inbox folder:
+- `{brain_dir}/{inbox_folder}/{filename}.md`
+
+### Finalizing
+
+When running `/brain done`:
+1. Updates status to `done` in frontmatter
+2. Suggests moving to archive (or projects/resources if PARA enabled)
+3. Confirms before moving
+
+## Commands
+
+Same commands as brain skill, but with Obsidian output:
+
+| Command                   | Obsidian Behavior                          |
+|---------------------------|--------------------------------------------|
+| `/brain plan {topic}`     | Creates in inbox with frontmatter          |
+| `/brain research {topic}` | Creates in inbox with frontmatter          |
+| `/brain review {topic}`   | Creates in inbox with frontmatter          |
+| `/brain note {text}`      | Quick capture to inbox                     |
+| `/brain done`             | Updates status, suggests archive/PARA move |

package/src/skills/brain-obsidian/SKILL.yaml

@@ -0,0 +1,45 @@
+name: brain-obsidian
+description: >-
+  Obsidian extension for brain skill. Adds YAML frontmatter, wikilinks, and folder
+  organization. Requires brain skill. Install this to use brain docs with your
+  Obsidian vault.
+version: 0.1.0
+status: beta
+dependencies:
+  - brain
+  # Optional: project skill enables linking features
+provides_output: false
+config_schema:
+  inbox_folder:
+    type: string
+    description: Folder for new brain docs
+    default: "0-Inbox"
+  archive_folder:
+    type: string
+    description: Folder for archived/stale docs
+    default: "4-Archives"
+  para_structure:
+    type: boolean
+    description: Enable full PARA folder organization
+    default: false
+  projects_folder:
+    type: string
+    description: Folder for active project docs (when para_structure is true)
+    default: "1-Projects"
+  areas_folder:
+    type: string
+    description: Folder for area docs (when para_structure is true)
+    default: "1-Areas"
+  resources_folder:
+    type: string
+    description: Folder for reference material (when para_structure is true)
+    default: "3-Resources"
+examples:
+  - title: "Create planning doc in vault"
+    code: |
+      /brain plan auth refactor
+      # Creates in vault's 0-Inbox/ with YAML frontmatter
+  - title: "Link to project"
+    code: |
+      /brain plan feature-x
+      # Frontmatter includes project: "[[feature-x]]"

package/src/skills/brain-obsidian/references/templates.md

@@ -0,0 +1,144 @@
+# Obsidian Brain Templates
+
+Templates with YAML frontmatter and wikilink support.
+
+## Plan Template
+
+```markdown
+---
+type: plan
+status: exploring
+created: {date}
+updated: {date}
+project: "[[{project}]]"
+tags: []
+---
+
+# {Topic}
+
+Planning {brief description}.
+
+## Context
+
+What we're solving and why.
+
+## Exploration
+
+Options and approaches considered.
+
+## Decision
+
+What we chose and why.
+
+## Next Steps
+
+- [ ] Action items
+```
+
+## Research Template
+
+```markdown
+---
+type: research
+status: exploring
+created: {date}
+updated: {date}
+project: "[[{project}]]"
+tags: []
+---
+
+# {Topic}
+
+Researching {brief description}.
+
+## Questions
+
+What we're trying to understand.
+
+## Findings
+
+What we've learned.
+
+## Summary
+
+Key takeaways.
+
+## Related
+
+- [[related-note-1]]
+- [[related-note-2]]
+```
+
+## Review Template
+
+```markdown
+---
+type: review
+status: exploring
+created: {date}
+updated: {date}
+project: "[[{project}]]"
+tags: []
+---
+
+# {Topic}
+
+Reviewing {brief description}.
+
+## Overview
+
+What's being reviewed and scope.
+
+## Observations
+
+Key findings and notes.
+
+## Recommendations
+
+Suggested changes or actions.
+
+## Verdict
+
+Overall assessment.
+```
+
+## Note Template
+
+```markdown
+---
+type: note
+created: {date}
+tags: []
+---
+
+# {Brief Title}
+
+{content}
+```
+
+## Template Variables
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `{Topic}` | Doc title from user input | "Auth Refactor" |
+| `{date}` | Current date (YYYY-MM-DD) | "2025-01-15" |
+| `{brief description}` | Context from conversation | "refactoring the authentication system" |
+| `{project}` | Active project name (if any) | "transaction-templates" |
+| `{content}` | User-provided text | (for notes) |
+
+## Frontmatter Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `type` | string | Doc type: `plan`, `research`, `review`, `note` |
+| `status` | string | Lifecycle: `exploring`, `drafting`, `decided`, `done`, `stale` |
+| `created` | date | Creation date (YYYY-MM-DD) |
+| `updated` | date | Last modification date |
+| `project` | wikilink | Link to related project: `"[[project-name]]"` |
+| `tags` | list | Tags for filtering: `[tag1, tag2]` |
+
+## Wikilink Conventions
+
+- Project links: `[[project-name]]` or `[[1-Projects/project-name/PROJECT]]`
+- Related notes: `[[note-name]]`
+- Use Obsidian's autocomplete to find existing notes

package/src/skills/brain-obsidian/references/workflows.md

@@ -0,0 +1,192 @@
+# Obsidian Brain Workflows
+
+Obsidian-specific procedures that override brain defaults.
+
+## Creating Docs
+
+**Overrides:** brain's Creating workflow
+
+**Steps:**
+
+1. **Resolve paths from config:**
+   - `brain_dir` from brain skill (your vault path)
+   - `inbox_folder` from brain-obsidian (default: `0-Inbox`)
+
+2. **Target folder:** `{brain_dir}/{inbox_folder}/`
+
+3. **Generate filename** using brain's naming conventions:
+   - Format: `{type}-{topic-slug}.md`
+
+4. **Check for active project:**
+   - If `/project` was loaded this session, use its name for `project` field
+   - Otherwise, leave `project` field empty or ask user
+
+5. **Apply Obsidian template** from `references/templates.md`:
+   - Include YAML frontmatter with all fields
+   - Set `created` and `updated` to today
+   - Set `status: exploring`
+
+6. **Create the file** in vault
+
+7. **Set as active doc** (same as brain)
+
+## Opening Docs
+
+**Overrides:** brain's Opening workflow
+
+**Steps:**
+
+1. **Search in brain_dir** (your vault):
+   ```
+   Glob: {brain_dir}/**/*{topic}*.md
+   ```
+
+2. **Rest of workflow same as brain** (fuzzy match, select, read, set active)
+
+## Updating Frontmatter
+
+When modifying any brain doc:
+
+1. **Update the `updated` field** to current date
+2. **Update `status`** if work has progressed
+3. **Add `project` link** if doc becomes associated with a project
+
+## Finalizing
+
+**Overrides:** brain's Finalizing workflow
+
+**Steps:**
+
+1. **Read active doc** and current location
+
+2. **Update frontmatter:**
+   - Set `status: done`
+   - Update `updated` date
+
+3. **Suggest destination based on content and config:**
+
+   **Without PARA (`para_structure: false`):**
+   | Condition | Suggested Destination |
+   |-----------|----------------------|
+   | Done/stale | `{archive_folder}/` |
+   | Still useful in inbox | Keep in place |
+
+   **With PARA (`para_structure: true`):**
+   | Condition | Suggested Destination |
+   |-----------|----------------------|
+   | Has active project link | `{projects_folder}/` |
+   | Ongoing area of responsibility | `{areas_folder}/` |
+   | Reference/learning value | `{resources_folder}/` |
+   | Stale or obsolete | `{archive_folder}/` |
+
+4. **Confirm move with user** before relocating
+
+5. **Move the file** if confirmed:
+   ```bash
+   mv "{brain_dir}/{inbox_folder}/{file}" "{brain_dir}/{destination}/{file}"
+   ```
+
+6. **Clear active doc** from session
+
+## Quick Notes
+
+**Overrides:** brain's Notes workflow
+
+**Steps:**
+
+1. **Create in inbox:** `{brain_dir}/{inbox_folder}/note-{date}-{slug}.md`
+
+2. **Use note template** with minimal frontmatter:
+   ```yaml
+   ---
+   type: note
+   created: {date}
+   tags: []
+   ---
+   ```
+
+3. **Fire-and-forget** (does not become active)
+
+## Project Integration (Optional)
+
+**Requires:** `project` skill. If not installed, suggest:
+> "Linking to projects requires the project skill. Install it with `droid` → Skills → project"
+
+When a project is loaded via `/project {name}`:
+
+1. **Remember project name** for session
+2. **New brain docs** automatically get `project: "[[{name}]]"` in frontmatter
+3. **Suggest linking** existing brain docs to the project
+
+## Adding Brain Doc to Existing Project
+
+**Trigger:** User says "add this to the project", "link this to project", or "capture in project"
+
+**Requires:** `project` skill. If not installed, suggest:
+> "Linking to projects requires the project skill. Install it with `droid` → Skills → project"
+
+For linking a brain doc (research, notes, design) to an existing project.
+
+**Steps:**
+
+1. **Check for active project:**
+   - If project loaded via `/project`, use that
+   - Otherwise, ask which project to link to
+
+2. **Update brain doc frontmatter:**
+   - Add `project: "[[{project-name}]]"`
+   - Update status if appropriate
+
+3. **Update project:**
+   - Add wikilink in Related section: `[[{brain-doc}]]`
+   - Or add to appropriate section (Key Decisions, Implementation, etc.)
+
+4. **Suggest moving brain doc:**
+   - With PARA: move to `{projects_folder}/` alongside project
+   - Without PARA: keep in place with project link
+
+## Promoting Brain Doc to New Project
+
+**Trigger:** User says "promote to project", "make this a project", or "convert to project"
+
+**Requires:** `project` skill. If not installed, suggest:
+> "Promoting to project requires the project skill. Install it with `droid` → Skills → project"
+
+For graduating a full tech design or plan into its own project.
+
+**Steps:**
+
+1. **Confirm promotion:**
+   - "This will create a new project from this brain doc. Continue?"
+
+2. **Extract project info from brain doc:**
+   - Title → project name
+   - Context → project overview
+   - Decision/Next Steps → initial tasks
+   - Status → project status
+
+3. **Create new project** via project skill:
+   - Generate PROJECT.md from brain doc content
+   - Create CHANGELOG.md with initial entry
+   - Place in projects directory
+
+4. **Update original brain doc:**
+   - Add `project: "[[{new-project}]]"` to frontmatter
+   - Update status to `done`
+   - Add note: "Promoted to project: [[{new-project}]]"
+
+5. **Handle the brain doc:**
+   - Option A: Keep as historical reference in `{resources_folder}/`
+   - Option B: Archive to `{archive_folder}/`
+   - Option C: Delete (content now lives in project)
+
+## Listing Docs
+
+**Overrides:** brain's Listing workflow
+
+Search in vault:
+```
+Glob: {brain_dir}/**/*.md
+```
+
+Filter to brain doc types by checking frontmatter for `type: plan|research|review|note`.