aboutsummaryrefslogtreecommitdiff
path: root/modules/org-agenda-config.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-06-28 03:39:46 -0400
committerCraig Jennings <c@cjennings.net>2026-06-28 03:39:46 -0400
commitf3baaffa5126ece216f698f5296288208c22c64b (patch)
treeef0bac7da88de1e10cd457f71e5dcb3188052546 /modules/org-agenda-config.el
parent6aabef6f1d7b0acc6ee8c12e8faeb57e0b62128d (diff)
downloaddotemacs-f3baaffa5126ece216f698f5296288208c22c64b.tar.gz
dotemacs-f3baaffa5126ece216f698f5296288208c22c64b.zip
docs: condense module commentaries to the terse header contract
22 module headers carried long user-manual commentaries (quick-starts, keybinding matrices, setup walkthroughs) that belong in user docs, not source. Each now states the purpose, load contract, and entry points tersely. ai-term also drops its stale F9 keybinding references (the scheme is C-; a plus M-SPC now) and a header line claiming a vertical-split that's really host-aware.
Diffstat (limited to 'modules/org-agenda-config.el')
-rw-r--r--modules/org-agenda-config.el49
1 files changed, 8 insertions, 41 deletions
diff --git a/modules/org-agenda-config.el b/modules/org-agenda-config.el
index 3234cc92..9ccd21d7 100644
--- a/modules/org-agenda-config.el
+++ b/modules/org-agenda-config.el
@@ -6,51 +6,18 @@
;; Layer: 3 (Domain Workflow).
;; Category: D/S.
;; Load shape: eager.
-;; Eager reason: daily agenda workflow; the user expects agenda available at the
-;; first session.
-;; Top-level side effects: one add-hook and an idle timer that builds the agenda
-;; file cache 10s after startup (guarded; spec tracks the cache lifecycle).
+;; Eager reason: agenda should be available in the first session.
+;; Top-level side effects: agenda hooks plus guarded idle cache build.
;; Runtime requires: user-constants, system-lib, cj-cache-lib.
;; Direct test load: yes.
;;
-;; Performance:
-;; - Caches agenda file list to avoid scanning projects directory on every view
-;; - Cache builds asynchronously 10 seconds after Emacs startup (non-blocking)
-;; - First agenda view uses cache if ready, otherwise builds synchronously
-;; - Subsequent views are instant (cached)
-;; - Cache auto-refreshes after 1 hour
-;; - Manual refresh: M-x cj/org-agenda-refresh-files (e.g., after adding projects)
+;; Org agenda configuration for global, project-scoped, and buffer-scoped task
+;; views. F8 opens the main agenda; modified F8 bindings narrow by project,
+;; current buffer, or task list.
;;
-;; Agenda views are tied to the F8 (fate) key.
-;;
-;; "We are what we repeatedly do.
-;; Excellence, then, is not an act, but a habit"
-;; -- Aristotle
-;;
-;; "...watch your actions, they become habits;
-;; watch your habits, they become character;
-;; watch your character, for it becomes your destiny."
-;; -- Lao Tzu
-;;
-;;
-;; f8 - MAIN AGENDA which organizes all tasks and events into:
-;; - all unfinished priority A tasks
-;; - the weekly schedule, including the habit consistency graph
-;; - all priority B tasks
-;;
-;; C-f8 - PROJECT AGENDA showing the main agenda filtered to a single project.
-;; Prompts for project selection, then shows overdue/hi-pri/schedule/B tasks
-;; scoped to that project's todo.org plus all calendars and inbox.
-;;
-;; s-f8 - TASK LIST containing all tasks from all agenda targets.
-;;
-;; M-f8 - TASK LIST containing all tasks from just the current org-mode buffer.
-;;
-;; NOTE:
-;; Files that contain information relevant to the agenda are: the inbox, the
-;; schedule-file, the synced calendars, and the per-project todo.org files found
-;; in immediate subdirectories of projects-dir. (org-roam notes are refile
-;; targets, not agenda sources -- see org-refile-config.el.)
+;; Agenda files come from inbox, schedule files, synced calendars, and immediate
+;; project todo.org files. The file list is cached and rebuilt asynchronously to
+;; keep normal agenda opens fast.
;;; Code:
(require 'user-constants)