aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-31 07:45:09 -0500
committerCraig Jennings <c@cjennings.net>2026-05-31 07:45:09 -0500
commit9311cb80ef9658537ea67b327db0646bd3511d03 (patch)
tree01e9bab7103f96457a97ec9de787a8c5f2707ed9 /README.org
parenta2515431213793656f9907e81fba2f73f535fd70 (diff)
downloadpearl-9311cb80ef9658537ea67b327db0646bd3511d03.tar.gz
pearl-9311cb80ef9658537ea67b327db0646bd3511d03.zip
docs: compose-window knobs and merge-refresh view preservation
Two shipped behaviors users can see weren't in the README. pearl-compose-window-side and pearl-compose-window-size control where the description/comment editor pops and how big it is. Both now appear in the configuration table. And the refresh section now explains that pearl-refresh-current-view merges by issue id and keeps point and your fold state, re-folding only the issues that changed, so editing then refreshing doesn't collapse what you were working in.
Diffstat (limited to 'README.org')
-rw-r--r--README.org5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.org b/README.org
index cc283f2..2b7c7a5 100644
--- a/README.org
+++ b/README.org
@@ -2,6 +2,7 @@
[[#features][Features]] | [[#installation][Installation]] | [[#quick-start][Quick Start]] | [[#commands][Commands]] | [[#configuration][Configuration]] | [[#development--testing][Development & Testing]] | [[#faq][FAQ]] | [[#history][History]] | [[#license][License]]
+[[https://github.com/cjennings/pearl/actions/workflows/ci.yml][https://github.com/cjennings/pearl/actions/workflows/ci.yml/badge.svg]]
[[https://www.gnu.org/licenses/gpl-3.0][https://img.shields.io/badge/License-GPLv3-blue.svg]]
" /We like lists because we don't want to die./ "
@@ -262,6 +263,8 @@ Ad-hoc filtering starts with a team, then completes states, projects, and labels
Sorting is local and deterministic. Query filters are AND-only; use a Linear Custom View for OR-heavy logic.
+=pearl-refresh-current-view= merges the fresh fetch into the buffer by issue id rather than rebuilding it: issues update in place, new matches are appended, and ones no longer in the result are dropped. Your view survives: point and the fold state of every untouched issue stay put, and only the subtrees that actually changed get re-folded. Editing an issue and refreshing won't collapse the subtree you were working in or scroll you back to the top.
+
*** Editing issues
Pearl has one write path. Edit an issue however you like in the buffer, then save it -- Pearl diffs each field against what it last fetched and pushes only what changed. Nothing pushes the moment you pick a value, and there is no per-field "push" command to remember. All issue commands work from anywhere inside an issue subtree.
@@ -375,6 +378,8 @@ Most users only need an API key and an output path. The rest are knobs for teams
| =pearl-title-case-headings= | Opt-in smart title case for issue titles (off) |
| =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 |
+| =pearl-compose-window-size= | Size of that side window (fraction or lines) |
| =pearl-debug= | Log request/response details to =*Messages*= |
If a fetch stops at the pagination cap, Pearl writes =#+LINEAR-TRUNCATED: yes= in the file header. Raise =pearl-max-issue-pages= if your result set is larger than the default 1000 issues.