aboutsummaryrefslogtreecommitdiff
path: root/docs/gui-design.md
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-09-17 12:11:42 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-09-17 12:11:42 +0200
commitbddbd74e4a73e8e32bcf648efd1cac5655f6d0cd (patch)
tree187e6a1fb722d9ab97d2076f69f997f5d371e943 /docs/gui-design.md
parentcd7425b81f963a948f0abe7df3f9e58e190c2b78 (diff)
downloadkrino-bddbd74e4a73e8e32bcf648efd1cac5655f6d0cd.tar.gz
krino-bddbd74e4a73e8e32bcf648efd1cac5655f6d0cd.zip
comments that explain the code, not how it was written
About 340 comments cited the development process: task and plan numbers, fix waves, rulings, reviewers, and the author in the third person with a date. None of that exists outside the work itself, so to a reader it pointed at nothing. Each one now states the engineering reason it was standing in front of; where a comment was provenance and nothing else, it is gone. References to docs/design.md and docs/gui-design.md by section stay: both ship with the repository. The design documents lose their amendment diaries - CHANGELOG.md is that record - and the GUI's says plainly that the window has gone further than the document. Only comments changed. Every .go file was parsed and its code printed with comments stripped, before and after: the two hashes are identical across all 175 files.
Diffstat (limited to 'docs/gui-design.md')
-rw-r--r--docs/gui-design.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/gui-design.md b/docs/gui-design.md
index a7c5089..602368f 100644
--- a/docs/gui-design.md
+++ b/docs/gui-design.md
@@ -1,10 +1,12 @@
# krino-gui design
-Status: draft, 2026-09-15. The window layout (B), the rules editor layout
-(A) and sections 1–4 were agreed from mockups; sections 5–6 are the
-author's defaults, to be corrected before implementation. Companion to
-`docs/design.md` (the engine spec, "the spec" below), whose §12 anticipated
-this GUI.
+The shape of the window, written before it was built and still the
+description of what it is for. Where the window has since gone further —
+the plan's columns, the filter and the sort, previews, settings —
+`CHANGELOG.md` is the record. Companion to `docs/design.md` (the engine
+spec, "the spec" below), whose §12 anticipated this GUI. Source comments
+and `gui-checklist.md` cite the sections here by number, so the numbering
+is stable.
`krino-gui` is a GTK4 window for what `krino` does in a terminal: review a
directory's plan and apply the chosen files, look back over runs and undo