summaryrefslogtreecommitdiff
path: root/docs/design.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-09-27 22:49:49 -0300
committerGabriel Schneider <[email protected]>2026-10-01 00:12:14 -0300
commitc8f0c25a854b8e169db08a84d1fdcd915a70aaa0 (patch)
treea468a2ae2596f9eb162270b32dfb3787e6b5c670 /docs/design.typ
parent71a9f04342493325c10b1b9bc122a88d41143782 (diff)
downloadpardes-c8f0c25a854b8e169db08a84d1fdcd915a70aaa0.tar.gz
pardes-c8f0c25a854b8e169db08a84d1fdcd915a70aaa0.zip
Point docs and comments at the files code moved to
Documentation only, no code change: README's reading order and layout, docs/design.typ's paragraph on where pane kinds and editor parts live, docs/helix-keys.md's code map (normalInput and the executors now in normal.zig and edit.zig, insertTab in edit.zig), docs/open-questions.md (execute and ttyForDir in exec.zig), and the comments that named pardes.zig for fold, Cell, takesCommandLine and runBuiltin (tools/gen_themes.zig, themes/helix.zig, detached/wire.zig, host_io.zig, lsp_zls.zig). docs/design.pdf is a retained fixture and is not regenerated. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/design.typ')
-rw-r--r--docs/design.typ11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/design.typ b/docs/design.typ
index 01b850b9..82bafb49 100644
--- a/docs/design.typ
+++ b/docs/design.typ
@@ -521,13 +521,18 @@ const platform_has_fs = !pardes.isolated and
the option is comptime, so every libc path below is dead code the compiler
removes rather than a branch that could be taken by accident.
-The core's one `pointerOperand` primitive owns click-word expansion and is shared
+The core's one `pointerOperand` primitive (in `exec.zig`) owns click-word expansion and is shared
verbatim by right-click and the delayed hover preview; that policy stays beside
input because it also observes live pane selections and wrapped grid coordinates.
-`panes.zig` keeps each pane kind's storage and operations together.
+Each pane kind keeps its storage and operations together in its own file
+(`File.zig`, `Terminal.zig`, `Output.zig`, `Mini.zig`, `pdf_view.zig`, and the
+image pane in `image.zig`), reached through `panes.zig` beside `Pane`.
`layout.zig` owns placement and presentation state. `pardes.zig` handles input
-and cross-pane state directly, without a pane vtable. Integration fixtures live
+and cross-pane state directly, without a pane vtable; the rest of the editor
+is split by thing as acme is: `edit.zig`, `normal.zig`, `look.zig`, `exec.zig`,
+`mouse.zig`, `Messages.zig`, `Pipe.zig`, `colors.zig`, `surface.zig`,
+`body_layer.zig` and `dump.zig`. Integration fixtures live
in `test/panes.zig`, `test/output.zig`, and `test/pdf.zig`.
= State