Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Developer Documentation

Technical documentation for building and extending this app. These docs describe established patterns and are intended for both human developers and AI coding agents.

Architecture & Patterns

Document Description
Architecture Guide High-level overview, mental models, system architecture
Rust Architecture Rust module organization and patterns
State Management Three-layer state onion, Zustand, TanStack Query
Error Handling Error propagation, user feedback, retry patterns

Core Systems

Document Description
Command System Unified action dispatch, command registration
Keyboard Shortcuts Global shortcut handling, platform modifiers
Menus Native menu building with i18n
Quick Panes Multi-window quick entry pattern
Tauri Commands Type-safe Rust-TypeScript bridge (tauri-specta)
Tauri Plugins Plugin usage and configuration

UI & UX

Document Description
UI Patterns CSS architecture, shadcn/ui components
Internationalization Translation system, RTL support
Notifications Toast and native notifications
Cross-Platform Platform detection, OS-specific adaptations

Data & Storage

Document Description
Data Persistence File storage patterns, atomic writes, SQLite
External APIs HTTP API calls, authentication, caching

Quality & Tooling

Document Description
Static Analysis ESLint, Prettier, ast-grep, knip, jscpd, React Compiler
Writing ast-grep Rules AI reference for creating custom rules
Testing Test patterns, Tauri mocking
Bundle Optimization Bundle size management
Logging Rust and TypeScript logging
Writing Docs Guide for creating and maintaining these docs

Release & Distribution

Document Description
Releases Release process, signing, auto-updates

Updating these docs: When adding new patterns or systems, update the relevant doc file and add a link here if creating a new document.