From b8fd1bac19afd84d684aa2f9e28371d0411a73fe Mon Sep 17 00:00:00 2001 From: Chris Lettieri Date: Sun, 27 Jul 2025 11:23:26 -0400 Subject: [PATCH] updated readme --- README.md | 209 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 191 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2cdde98..02a70e3 100644 --- a/README.md +++ b/README.md @@ -61,32 +61,165 @@ This command analyzes a set of linked notes and synthesizes them into a coherent 2. Open this root note 3. Hit `CMD+P` (or `CTRL+P` on Windows/Linux) to open the command palette 4. Run `OpenAugi: Distill Linked Notes` +5. **NEW**: Select a custom prompt "lens" or use the default prompt The plugin will: +- Show a prompt selection modal where you can choose a processing lens - Gather all linked notes -- Analyze their content together +- Analyze their content together using your selected lens - Create new atomic notes that synthesize and organize the information - Generate a summary that connects the key concepts - Extract any actionable tasks found across the notes ### 3. Distill Recent Activity -This command automatically discovers and distills notes that have been recently modified, perfect for daily/weekly reviews. +This command automatically discovers and distills notes that have been recently modified or have date prefixes in their filenames, perfect for daily/weekly reviews. **Usage:** 1. Hit `CMD+P` (or `CTRL+P` on Windows/Linux) to open the command palette 2. Run `OpenAugi: Distill Recent Activity` 3. Configure your preferences in the modal: - - **Days to look back**: How many days of activity to include (default: 7) + - **Time Window Selection**: + - **Default Mode**: "Days to look back" - specify how many days of activity to include (default: 7) + - **Date Range Mode**: Toggle "Use specific date range" to select exact start and end dates - **Filter journal sections**: For journal-style notes with date headers, only include recent sections - **Root note**: Optionally specify a note to provide additional context - **Exclude folders**: Skip folders like Templates or Archive +4. Click "Select Notes" to preview and choose which notes to include: + - View all discovered notes with their modification dates + - Check/uncheck individual notes to customize your selection + - Use "Select All" toggle for bulk selection +5. Optional: Click "Save as Collection" to create a persistent checkbox list for future use +6. Click "Distill" to process +7. Select a custom prompt "lens" or use the default prompt -The plugin will: -- Automatically find all notes modified within your specified time window +**The plugin will:** +- Show discovered notes in an interactive checkbox list +- Process only the notes you've selected - For journal-style notes with date headers (e.g., `### 2024-01-20`), extract only recent sections -- Synthesize the recent activity into organized atomic notes -- Create a comprehensive summary of your recent work +- Synthesize the activity into organized atomic notes using your selected lens +- Create atomic notes in a timestamped session folder (e.g., `OpenAugi/Notes/Recent Activity 2024-01-20 14-30-52/`) +- Generate a summary with a descriptive name based on content + +**Date Range Selection:** +Toggle between two modes for selecting your time window: +- **"Last N days"**: Quick selection for recent activity (1 day, 7 days, etc.) +- **Specific date range**: Choose exact start and end dates using date pickers + - Perfect for reviewing specific periods like "last week" or "this month" + - Includes all notes modified or dated within the range + +**Note Selection Interface:** +The new selection interface lets you: +- Preview all notes that match your criteria before processing +- See each note's folder location and modification time +- Exclude specific notes by unchecking them +- Save your selection as a collection for future reference + +**Save as Collection:** +Create a persistent record of your note selection: +- Saves to `OpenAugi/Collections/` folder +- Preserves checked/unchecked states +- Can be used later with "Distill Linked Notes" command +- Perfect for creating curated sets of notes for repeated analysis + +**Date-Based Note Discovery:** +Notes with filenames beginning with `YYYY-MM-DD` format are automatically included if their date falls within your specified time window, regardless of when they were last modified. This is perfect for: +- Meeting notes dated by when they occurred +- Daily logs or journal entries +- Event-based documentation +- Any notes you want to organize by their content date rather than modification time + +## Custom Prompt Lenses + +**NEW**: OpenAugi now supports custom prompt templates that act as "lenses" to focus processing on specific aspects of your notes. + +### How Custom Prompts Work + +Custom prompts allow you to guide OpenAugi's AI processing with specific perspectives or focus areas. When you run distillation commands, you can select from your custom prompts to process notes through different "lenses" - extracting different types of insights from the same content. + +### Using Custom Prompts + +1. When you run "Distill Linked Notes" or "Distill Recent Activity", you'll see a prompt selection modal +2. Choose from any prompt in your prompts folder (default: `OpenAugi/Prompts`) +3. The selected prompt replaces the default processing instructions while keeping the structured output format +4. Or select "Use default prompt" for general-purpose processing + +### Understanding the Prompt System + +#### Default Prompt +When no custom prompt is selected, OpenAugi uses its built-in default prompt that: +- Acts as an "expert knowledge curator" +- Creates atomic notes focusing on distinct concepts and ideas +- Deduplicates and merges overlapping information +- Extracts genuinely actionable tasks +- Generates comprehensive summaries highlighting connections + +#### How Custom Prompts Replace the Default +When you select a custom prompt: +1. **Your custom prompt replaces** the default instruction section +2. **The system always adds**: + - Any custom context from your notes (if present) + - JSON output structure requirements + - The actual note content to process + +This means your custom prompt changes HOW the content is analyzed, but not the OUTPUT format. + +### Creating Your Own Prompts + +To create a custom prompt: + +1. Create a new markdown file in your prompts folder +2. Write your instructions following this structure: + - Start with a brief description of the lens perspective + - Include sections for: + - Creating atomic notes (with your specific focus) + - Extracting tasks (if relevant to your lens) + - Creating a summary (with your desired emphasis) +3. Save the file with a descriptive name (e.g., "Technical Documentation.md") + +#### Template Structure +```markdown +You are an expert [your role] helping users [your purpose]. + +# Instructions +[Your specific focus and approach] + +### 1. Create Atomic Notes +- [Your specific criteria for what makes a good atomic note] +- [How to identify relevant concepts for your lens] +- [Any special formatting or emphasis] + +### 2. Extract Tasks +- [What counts as a task in your context] +- [How to format and prioritize tasks] + +### 3. Create a Summary +- [What to emphasize in the summary] +- [How to structure the summary for your use case] +``` + +### Example Prompts Included + +- **Research Focus**: Extracts academic insights, methodologies, and research questions +- **Project Management**: Focuses on deliverables, timelines, and actionable tasks +- **Personal Reflection**: Captures personal insights, emotions, and growth moments + +### Tips for Writing Effective Prompts + +- Be specific about what types of information to extract +- Maintain the structure of atomic notes, tasks, and summary +- Use clear, directive language +- Keep the focus narrow for best results +- Remember that Obsidian backlinks should still be used to connect ideas +- Test your prompt with various content types to ensure consistency + +### Important Notes + +- The JSON output structure is always preserved regardless of the prompt +- Custom prompts only affect the instructional content, not the response format +- Test your prompts with different types of notes to ensure they work as expected +- Custom prompts work in addition to (not instead of) any custom context in your notes +- If no prompt files exist in your prompts folder, only the default option will be available ## Custom Context @@ -151,6 +284,7 @@ OpenAugi provides several configuration options in Settings → OpenAugi: - **OpenAI API Key**: Your API key for processing (required) - **Summaries Folder**: Where summary files are saved (default: `OpenAugi/Summaries`) - **Notes Folder**: Where atomic notes are saved (default: `OpenAugi/Notes`) +- **Prompts Folder**: Where custom prompt templates are stored (default: `OpenAugi/Prompts`) - **Use Dataview**: Enable processing of dataview queries in distillation ### Recent Activity Settings @@ -192,17 +326,56 @@ When using "Distill Recent Activity" with a 7-day window, only the recent sectio ## Output Structure -OpenAugi creates two types of files: -1. **Summary files** - Placed in your designated summary folder, containing: - - A concise summary of the content - - Links to all atomic notes - - Tasks extracted from the content - - For distilled notes: Links to source notes - -2. **Atomic notes** - Placed in your designated notes folder, each containing: - - A single, self-contained idea - - Context and supporting details - - Backlinks to related notes where relevant +OpenAugi creates organized outputs for better note management: + +### Summary Files +Placed in your designated summary folder (`OpenAugi/Summaries` by default): +- **Transcript summaries**: `[original-name] - summary.md` +- **Distilled notes**: `[root-note-name] - distilled.md` +- **Recent activity**: `Recent Activity YYYY-MM-DD - [first-note-title].md` + +Each summary contains: +- A concise overview of the processed content +- Links to all generated atomic notes +- Extracted tasks with context +- Source note references (for distillations) + +### Atomic Notes +Organized in session-specific folders within your notes folder (`OpenAugi/Notes` by default): +- **Transcript sessions**: `Transcript YYYY-MM-DD HH-mm-ss/` +- **Distill sessions**: `Distill [RootNoteName] YYYY-MM-DD HH-mm-ss/` +- **Recent activity sessions**: `Recent Activity YYYY-MM-DD HH-mm-ss/` + +Each atomic note contains: +- A single, self-contained idea +- Relevant context and supporting details +- Backlinks to related concepts +- Clear, descriptive titles + +### Collection Notes +Saved note selections for future processing (`OpenAugi/Collections` by default): +- **Format**: `Recent Activity YYYY-MM-DD HH-mm-ss.md` +- Contains checkbox lists of selected notes +- Preserves selection criteria and configuration +- Can be processed later using "Distill Linked Notes" + +## Advanced Features + +### Checkbox-Based Collections +OpenAugi recognizes and processes checkbox-style note collections: +```markdown +- [x] [[Note to include]] +- [ ] [[Note to exclude]] +- [x] [[Another included note]] +``` +When running "Distill Linked Notes" on such a collection, only checked items are processed. + +### Session Folders +All atomic notes from a single processing session are kept together in timestamped folders, making it easy to: +- Review all outputs from a specific session +- Move or archive related notes together +- Track the evolution of your ideas over time +- Avoid mixing notes from different contexts # Get involved, let's build augmented intelligence