cognitive/docs/tools/obsidian_usage.md
Daniel Ari Friedman 30b11dfb3a Updates
2025-02-07 12:22:16 -08:00

10 KiB

Obsidian Usage Guide

Overview

Obsidian serves as our knowledge management system, providing powerful linking and visualization capabilities for cognitive modeling networks.

Vault Structure

Core Directories

📁 knowledge_base/          # Main knowledge repository
├── agents/                # Agent definitions
├── beliefs/              # Belief networks
├── goals/               # Goal hierarchies
├── actions/             # Action repertoires
├── observations/        # Observation patterns
└── relationships/       # Node relationships

📁 templates/              # Template definitions
└── node_templates/      # Node type templates

📁 docs/                  # Documentation

Node Types and Templates

Core Node Types

See node_types for detailed specifications.

Linking Patterns

  • Use [[filename]] for direct links
  • Use [[filename|alias]] for custom link text
  • Reference linking_patterns for conventions
  • Automatically tracked by Obsidian
  • View in right sidebar
  • Essential for network_analysis

Knowledge Organization

Tags

Common tags:

  • #agent
  • #belief
  • #goal
  • #action
  • #observation
  • #relationship

See tagging_guide for conventions.

YAML Frontmatter

---
type: agent
id: "agent_001"
created: 2024-02-05
modified: 2024-02-05
tags: [agent, cognitive-model]
aliases: []
---

Visualization

Graph View

  • Access via Graph View button
  • Shows knowledge network structure
  • Color-coded by node_types
  • Configurable layouts

Filters

Integration Features

With Cursor

With Git

  • Version control integration
  • Collaboration features
  • See git_workflow

Workflows

Creating New Nodes

  1. Use template hotkeys
  2. Fill in frontmatter
  3. Add content
  4. Establish links See workflow_guides for details.

Maintaining Networks

Plugins and Extensions

Core Plugins

  • Graph View
  • Backlinks
  • Tags
  • Templates

Community Plugins

  • Dataview (for queries)
  • Calendar (for temporal tracking)
  • Mind Map (for hierarchies)

Best Practices

Organization

Linking

  • Be specific with links
  • Use bidirectional linking
  • Maintain link context
  • Follow linking_patterns

Documentation

Tips and Tricks

Keyboard Shortcuts

  • Ctrl/Cmd + O - Quick switcher
  • Ctrl/Cmd + E - Toggle edit/preview
  • [[ - Create link
  • See shortcuts_guide
  • Use tags for categorization
  • Use frontmatter for metadata
  • Full-text search available
  • See search_guide

Troubleshooting

Common Issues

  • Broken links
  • Template issues
  • Plugin conflicts See troubleshooting for solutions.

References

Advanced Features

Graph Analysis Tools

  • network_metrics - Analyzing knowledge structure
    • Centrality measures
    • Clustering coefficients
    • Path analysis
  • graph_layouts - Visualization options
    • Force-directed
    • Hierarchical
    • Circular
  • graph_filtering - Custom views
    • Tag-based filters
    • Node type filters
    • Relationship filters

Knowledge Management Patterns

Information Architecture

  • information_architecture - Structural design
    • Hierarchical organization
    • Networked relationships
    • Semantic grouping
  • metadata_management - Content enrichment
    • YAML frontmatter
    • Custom properties
    • Automatic tracking
  • content_lifecycle - Document management
    • Creation workflows
    • Review processes
    • Archival procedures

Advanced Linking

Automation and Scripting

Custom Scripts

  • automation_scripts - Task automation
    • File creation
    • Content processing
    • Batch operations
  • templater_scripts - Dynamic templates
    • Context-aware templates
    • Dynamic content
    • Conditional logic
  • dataview_queries - Data extraction
    • Custom queries
    • Data visualization
    • Report generation

Integration Points

  • api_integration - External connections
    • REST APIs
    • GraphQL endpoints
    • Webhook triggers
  • plugin_development - Custom extensions
    • Plugin architecture
    • API documentation
    • Development guides
  • automation_workflows - Process automation
    • GitHub Actions
    • Local scripts
    • Scheduled tasks

Collaborative Features

Multi-User Workflows

Version Control

  • git_workflows - Source control
    • Branch management
    • Merge strategies
    • Conflict resolution
  • backup_strategies - Data protection
    • Automated backups
    • Recovery procedures
    • Redundancy planning
  • change_tracking - History management
    • Version history
    • Change logs
    • Audit trails

Advanced Visualization

Custom Views

  • custom_views - Specialized displays
    • Timeline views
    • Kanban boards
    • Mind maps
  • data_visualization - Information display
    • Charts and graphs
    • Data tables
    • Interactive diagrams
  • presentation_mode - Content sharing
    • Slide shows
    • Live presentations
    • Export formats

Network Analysis

System Integration

Development Tools

  • ide_integration - Code editing
    • Cursor integration
    • VSCode workflow
    • Git support
  • build_tools - Project management
    • Task runners
    • Build scripts
    • Deploy processes
  • testing_framework - Quality assurance
    • Unit tests
    • Integration tests
    • Documentation tests

External Tools

  • external_tools - Tool connections
    • Reference managers
    • Note-taking apps
    • Task managers
  • data_exchange - Information flow
    • Import/export
    • Sync protocols
    • Data migration
  • api_documentation - Interface specs
    • REST APIs
    • GraphQL schemas
    • WebSocket endpoints

Performance Optimization

Content Organization

Resource Management

Security and Privacy

Access Control

  • access_management - Permission systems
    • User roles
    • File permissions
    • Share settings
  • encryption_options - Data protection
    • File encryption
    • Key management
    • Secure sharing
  • audit_logging - Activity tracking
    • User actions
    • System events
    • Change history

Data Protection

  • data_security - Information safety
    • Encryption methods
    • Secure storage
    • Safe sharing
  • privacy_controls - Information control
    • Data visibility
    • Access logging
    • Usage tracking
  • compliance_management - Regulation adherence
    • Data regulations
    • Privacy laws
    • Industry standards

Maintenance and Support

System Maintenance

Documentation

References and Resources

Official Resources

Community Resources

Learning Resources

Appendices

Configuration Reference

Template Library

Glossary