Dvarim docs

How to use Dvarim, where your to-dos live, and how to run your own copy.

These pages are how Dvarim works, written down. It's my to-do app, and every to-do in it is a line in a Markdown file you can open in Obsidian or any text editor. If you're new, read "What is Dvarim?" first and then Install, which takes you from nothing to a working copy. The pages under "Using Dvarim" follow the app from the lists down to a single to-do, and the ones at the bottom are the technical notes I keep for myself.

Getting started

• What is Dvarim? — what it does, what works where, and what it plays with
• How I use it — my own routine with it, from the Signal bot to the Mac's quick entry
• Install — the web app, the Mac and Android apps, and where each one gets its to-dos

Using Dvarim

• The lists — Inbox, Today, This Evening, Upcoming, Anytime, Someday, Logbook and Trash
• Areas, projects and headings — how bigger things are organized
• To-dos — the to-do card: notes, checklists, tags, moving, completing
• When, deadlines and reminders — "When" and "Deadline" are different, and why that matters
• Repeating to-dos — on a schedule or after completion
• Quick entry and keyboard shortcuts — every way in, and every key
• Quick Find — finding any list, project, tag or to-do by typing
• Settings — what each pane does

Your files

• Your to-dos as Markdown — the file format in plain words
• Using it with Obsidian — editing the same files in both, and the Obsidian Tasks plugin

Devices & sync

• The Mac app — Quick Entry on ⌃Space, Today in the menu bar, notifications, Shortcuts
• The Android app — the Today widget, sharing into Dvarim, reminders
• Sync — a synced folder (Syncthing, iCloud Drive) or the built-in WebDAV sync
• Calendars — your calendar in Today and Upcoming, and your to-dos in other apps

Running your own server

• Your own server — one Docker container, a folder, a password
• Other people on your server — inviting family and friends to keep their own to-dos on it

Under the hood

• Developing Dvarim — building, testing, and how changes reach the server
• The file format — the full spec of the Markdown, marker by marker
• Architecture — how the files, the engine, the server and the apps fit together
• Sync you can trust — the per-to-do merge rules and how they're proved
• The HTTP API — every route the app and the native apps call
• The native bridge — how the Mac and Android apps hand the page a folder
• Integrations — Radicale, Signal and the to-do mirror, in detail
• Deploying on my server — how my own copy is built, run and auto-deployed
• Roadmap — the decisions behind the engine, the apps and sync, and what's left

Start with What is Dvarim?, and if something here doesn't match what the app does, feel free to tell me.