aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-06-05 00:31:56 -0500
committerCraig Jennings <c@cjennings.net>2026-06-05 00:31:56 -0500
commit387c8a9ff9828d1b024987d136d216ef12c5103f (patch)
tree130257f97e7481f6224cc959878323d94c90a9f7 /README.org
parent4ca24db97d00bdf8ea1fff49f2c6545ff9d10514 (diff)
downloadpearl-387c8a9ff9828d1b024987d136d216ef12c5103f.tar.gz
pearl-387c8a9ff9828d1b024987d136d216ef12c5103f.zip
feat(render): overlay content glyphs on issue and comment headings
A ticket glyph now sits on every issue heading and a speech balloon on every comment heading. The glyph rides a display overlay on the space after the leading stars, so it lands ahead of the TODO keyword where a literal text prefix can't go (Org wants the keyword first). The choice is keyed on the heading's own drawer, LINEAR-ID for issues and LINEAR-COMMENT-ID for comments, so it's per-heading-type rather than per outline level. Display-only: the buffer text is untouched, so parse, sync, and merge are unaffected. It reuses the comment-highlight overlay pattern and rides the same redecoration trigger. It's applied synchronously because the glyph is drawer-driven and shouldn't wait on the viewer lookup. Behind pearl-show-glyphs (default on). Overlays go stale after a manual heading edit until the next refresh.
Diffstat (limited to 'README.org')
-rw-r--r--README.org3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.org b/README.org
index e0d302b..443b217 100644
--- a/README.org
+++ b/README.org
@@ -376,6 +376,8 @@ A fetched Pearl file is intentionally readable. The header records the source, r
The =LINEAR-*= properties store both ids and display names so common commands do not need a network lookup just to render. The hash properties are provenance for conflict-aware sync.
+Pearl overlays a glyph on each heading's leading stars: a ticket on an issue, a speech balloon on a comment. The glyph is display-only and keyed on the heading's drawer, so it never enters the buffer text or interferes with sync. Turn it off with =pearl-show-glyphs=.
+
*** Fidelity to Linear
:PROPERTIES:
:CUSTOM_ID: fidelity-to-linear
@@ -407,6 +409,7 @@ Most users only need an API key and an output path. The rest are knobs for teams
| =pearl-request-timeout= | Synchronous request timeout in seconds |
| =pearl-fold-after-update= | Re-fold the active page after fetch/refresh |
| =pearl-title-case-headings= | Opt-in smart title case for issue titles (off) |
+| =pearl-show-glyphs= | Glyph on issue/comment headings (on) |
| =pearl-surface-buffer= | Show the active buffer after a command updates it |
| =pearl-surface-select-window= | Move focus to the surfaced buffer |
| =pearl-compose-window-side= | Side the compose/conflict buffer opens from |