From a84d7a6031ceebfcd02560a30c4dec5157007c03 Mon Sep 17 00:00:00 2001 From: Vatsal Raina <154910553+VatsalRaina01@users.noreply.github.com> Date: Wed, 7 Oct 2026 10:01:48 +0530 Subject: [PATCH] docs(taskpaper): correct the doing file format in the concepts page --- docs/site/getting-started/concepts.md | 37 +++++++++++++-------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/site/getting-started/concepts.md b/docs/site/getting-started/concepts.md index 460e6ac..61e8b66 100644 --- a/docs/site/getting-started/concepts.md +++ b/docs/site/getting-started/concepts.md @@ -5,7 +5,7 @@ that file is structured and the key ideas behind it. ## The Doing File -By default, `doing` reads and writes a file at `~/.doing` or `~/Library/Application\ Support/doing/what_was_i_doing.md` +By default, `doing` reads and writes a file at `~/.doing` or `~/Library/Application Support/doing/what_was_i_doing.md` on macOS. You can change this in your configuration or pass `--doing-file` to any command. The file is plain text in TaskPaper format, which means it is human-readable, easy to grep, and works @@ -13,23 +13,23 @@ well with version control. ## Sections -The doing file is organized into **sections**. Each section is a top-level heading followed by a colon. +The doing file is organized into sections. Each section is a top-level heading followed by a colon. Two sections are used by default: -- **Currently** -- entries you are actively working on. -- **Archive** -- entries that have been finished. +- Currently - entries you are actively working on. +- Archive - entries that have been finished. You can create custom sections to organize your work however you like. ## Entries -An entry is a single line inside a section. It consists of a title and a timestamp: +An entry is a single line inside a section, indented with a tab. It consists of a timestamp and a title separated by a pipe, optionally followed by a unique id: ```text -- Writing API integration tests @started(2026-03-30 14:05) + - 2026-03-30 14:05 | Writing API integration tests <0123456789abcdef0123456789abcdef> ``` -Entries always start with a dash (`-`). The `@started` tag records when the entry was created. +Entries always start with a tab and a dash (`-`). The timestamp at the front records when the entry was created. When you write entries by hand, the 32 character id in angle brackets is optional and `doing` will manage it for you. ## Tags @@ -37,27 +37,26 @@ Tags are words prefixed with `@`. They can appear anywhere in the entry title. S in parentheses: ```text -- Deploy staging server @deploy @done(2026-03-30 15:30) + - 2026-03-30 15:30 | Deploy staging server @deploy @done(2026-03-30 15:30) ``` Common built-in tags: | Tag | Purpose | | --------------------- | ------------------------------- | -| `@started(timestamp)` | When the entry was created | | `@done(timestamp)` | When the entry was finished | -You can use any custom tags you want -- `@meeting`, `@bugfix`, `@project(website)`, and so on. Tags are +You can use any custom tags you want, like `@meeting`, `@bugfix`, or `@project(website)`. Tags are useful for filtering entries with commands like `doing show` and `doing tag`. ## Notes -Entries can have multi-line notes attached to them. Notes are indented lines that follow an entry: +Entries can have multi-line notes attached to them. Notes are indented lines that follow an entry, using two tabs: ```text -- Investigating memory leak in worker pool @started(2026-03-30 10:00) - Heap profile shows growth in the connection cache. - Suspect the idle timeout is not firing. + - 2026-03-30 10:00 | Investigating memory leak in worker pool + Heap profile shows growth in the connection cache. + Suspect the idle timeout is not firing. ``` You can add notes when creating an entry with the `--note` or `-n` flag, or edit them later with @@ -69,13 +68,13 @@ Here is an example of a doing file on disk: ```taskpaper Currently: -- Refactoring error handling in CLI commands @started(2026-03-30 14:30) - Switching from anyhow to thiserror for typed errors. -- Writing unit tests for tag parser @started(2026-03-30 13:00) + - 2026-03-30 14:30 | Refactoring error handling in CLI commands + Switching from anyhow to thiserror for typed errors. + - 2026-03-30 13:00 | Writing unit tests for tag parser Archive: -- Set up CI pipeline for release builds @done(2026-03-30 12:00) @project(infra) -- Fix off-by-one in date range query @done(2026-03-29 17:00) @bugfix + - 2026-03-30 12:00 | Set up CI pipeline for release builds @done(2026-03-30 12:00) @project(infra) + - 2026-03-29 17:00 | Fix off-by-one in date range query @done(2026-03-29 17:00) @bugfix ``` ## Templates -- knotmirror 0.0.1