From 33790043d8b78275360639128d843fdc1ab80a75 Mon Sep 17 00:00:00 2001 From: Levi Neely Date: Thu, 8 Oct 2026 20:44:50 +0200 Subject: [PATCH] docs: bring all docs up to date after the split/rename MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - docs/radials.example.json: the config comments and the launcher-door action names were still Ollie-era — 'Copy to .../olliepalette/radials.json' -> 'deft/radials.json', and ollie_goto_file/ollie_goto_symbol/ollie_command_palette -> deft_goto_file/deft_goto_symbol/deft_command_palette (the objectNames the radial plugin actually resolves; verified against radialconfig.cpp). - docs/PLUMBING.md: replaced the dead 'See PLAN.md' pointer with the real implementation location (src/plumb/, plumb_lib + plumbplugin). - README: link docs/radials.example.json from the radial Configure note. - AGENTS.md: drop the environment-specific LSP-bridge remark (not universal contributor guidance); keep the plain 'read before you edit' rule. PERF.md and SAM.md were already accurate and are unchanged. --- AGENTS.md | 4 +--- README.md | 3 ++- docs/PLUMBING.md | 5 +++-- docs/radials.example.json | 10 +++++----- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index a9a2872..a1bdafd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -56,9 +56,7 @@ cmake --install build # installs the 6 .so to ~/.local/.../qt6/plu - **Match the existing style.** No pointless indirection; file-local helpers duplicated across plugins are preferred over a shared lib for a few trivial functions. -- **Never read a file you haven't read, then rewrite from memory.** Use targeted - edits. The LSP bridge in this environment is unreliable; prefer the Tree-sitter - (`code_*`) and `file_*` tools. +- **Never rewrite a file from memory.** Read it first, then make targeted edits. ## Two load-bearing design decisions diff --git a/README.md b/README.md index 609fbee..dfa7ccd 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,8 @@ comment, case changes…), so the mouse stays at the text. - Slices can trigger any action by name, including `palette`/`switch` doors. - **Configure:** drop a `radials.json` at `~/.config/deft/radials.json` to replace the built-in tree; when it is absent, empty, or invalid, the built-in - default is used. + default is used. See [docs/radials.example.json](docs/radials.example.json) + for the format. ### `[deft:nineify] acme` — acme editing gestures diff --git a/docs/PLUMBING.md b/docs/PLUMBING.md index 143bcd4..24810a3 100644 --- a/docs/PLUMBING.md +++ b/docs/PLUMBING.md @@ -6,8 +6,9 @@ line, or a directory as a folder). The *routing* — what a plumbed string means lives in the plumber's rules, not in Kate. This document covers the user-side rules in `~/lib/plumbing` that make files and directories open in Kate. -See `PLAN.md` → "Plumbing" for the implementation (the native 9P client, the -edit-port reader, and the in-process handler). +The implementation (the native 9P client, the edit-port reader, and the +in-process handler) lives in `src/plumb/` — `plumb_lib` is the pure codec/9P +client and `plumbplugin.{h,cpp}` is the Kate glue. ## How plumbing reaches Kate diff --git a/docs/radials.example.json b/docs/radials.example.json index 29f4b82..3cc7caa 100644 --- a/docs/radials.example.json +++ b/docs/radials.example.json @@ -1,7 +1,7 @@ { - "//": "Ollie radial-menu config. Copy to $XDG_CONFIG_HOME/olliepalette/radials.json", + "//": "Deft radial-menu config. Copy to $XDG_CONFIG_HOME/deft/radials.json", "//trigger": "Each radial may have a key 'trigger' (e.g. \"Alt+R\") and/or a mouse 'button' (\"RightButton\" | \"MiddleButton\").", - "//slices": "A slice is a leaf { \"label\", \"action\": } or a branch { \"label\", \"slices\": [ ... ] }. The special action \"ollie_command_palette\" opens the M-x palette.", + "//slices": "A slice is a leaf { \"label\", \"action\": } or a branch { \"label\", \"slices\": [ ... ] }. The special action \"deft_command_palette\" opens the M-x palette.", "radials": [ { "name": "edit", @@ -19,9 +19,9 @@ { "label": "Align", "action": "tools_align" }, { "label": "UPPER", "action": "tools_uppercase" }, { "label": "lower", "action": "tools_lowercase" }, - { "label": "File…", "action": "ollie_goto_file" }, - { "label": "Sym…", "action": "ollie_goto_symbol" }, - { "label": "M-x", "action": "ollie_command_palette" } + { "label": "File…", "action": "deft_goto_file" }, + { "label": "Sym…", "action": "deft_goto_symbol" }, + { "label": "M-x", "action": "deft_command_palette" } ] } ]