aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--LICENSE338
-rw-r--r--docs/superpowers/specs/2026-09-16-conky-lua-dashboard-design.md252
-rw-r--r--idea1.pngbin0 -> 340017 bytes
-rw-r--r--idea2.pngbin0 -> 166041 bytes
5 files changed, 591 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..72b17c9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+HANDOFF.md
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..9efa6fb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,338 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Moe Ghoul>, 1 April 1989
+ Moe Ghoul, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/docs/superpowers/specs/2026-09-16-conky-lua-dashboard-design.md b/docs/superpowers/specs/2026-09-16-conky-lua-dashboard-design.md
new file mode 100644
index 0000000..059205b
--- /dev/null
+++ b/docs/superpowers/specs/2026-09-16-conky-lua-dashboard-design.md
@@ -0,0 +1,252 @@
+# Conky Lua dashboard: design
+
+Date: 2026-09-16
+Status: approved, pending implementation plan
+
+## What this is
+
+A fullscreen Conky dashboard for Hyprland, drawn with Cairo from Lua, living on
+a special workspace that a keybind and a waybar launcher toggle.
+
+It replaces `templates/conky.conf.in` in the `unified-desktop-theme` (UDT) repo.
+That template is a 6.3K variables-and-`${execi}` config rendering a flat text
+column on the desktop layer. This repo becomes the canonical Conky consumer of
+the UDT palette: UDT's `install.sh` keeps rendering the template and restarting
+Conky exactly as it does today, only the source of the template moves here.
+
+The old config is not thrown away. Its hardware discovery, in particular the
+hwmon glob-by-name discipline, is the one part that must not regress and is
+carried over deliberately (see "Data").
+
+## Reference material
+
+Two mockups in the repo root, both **layout and shape only, not colour**.
+Colour comes from the UDT palette in every case.
+
+`idea1.png` (2560x1600): card grid, thin-bordered rounded rectangles, monospace
+labels in small caps over larger values. Supplies the card vocabulary.
+
+`idea2.png` (307x773): the clock treatment. Very heavy numerals, hour stacked
+over minute, left-aligned, tight leading; small-caps weekday beneath; date as
+`12 / MAY / 2023` with slash separators. Also shows ring gauges and album art,
+useful for later widgets.
+
+### Deliberately not taken from the mockups
+
+- **Lumon branding and "UNITED IN SEVERANCE"** — user asked for layout only.
+- **Task list with a Sync button** — needs an application backend, not a system
+ monitor's job.
+- **"Sent to Jackie" mic button** — interactive. Conky can draw a button; it
+ cannot receive a click.
+- **`idea1.png`'s vertical right-hand stack** — does not fit the target screen.
+ See "Screen geometry".
+
+## Screen geometry
+
+The primary monitor is **2560x1080**; the secondary is 1920x1080. `idea1.png` is
+2560x1600, so its four-card vertical stack cannot be reproduced at 1080px tall.
+
+This is why the layout is expressed in **grid cells** rather than pixels: the
+cell size derives from the actual surface dimensions, so one layout table works
+on both monitors and the column count, not a set of hand-tuned offsets, decides
+whether the result reads as horizontal or dense.
+
+v1 targets the primary monitor. Per-monitor layout variants are not built (see
+"Explicitly out of scope").
+
+## Verified platform facts
+
+Established by experiment on this machine before the design was fixed, because
+each one invalidates a common approach.
+
+**Conky build:** 1.24.2-pre, with Lua bindings for Cairo and Imlib2, ARGB visual,
+and Wayland output. Lua 5.4.9.
+
+**Cairo on Wayland needs `conky_surface()`.** The idiom in essentially every
+Conky-Lua tutorial is:
+
+ cairo_xlib_surface_create(conky_window.display, conky_window.drawable, ...)
+
+Under `out_to_wayland = true` there is no Xlib drawable: `conky_window.drawable`
+and `conky_window.visual` are both **nil**, and Conky emits a deprecation
+warning pointing at `conky_surface()` instead. `conky_surface()` was tested and
+returns a live surface; Cairo fills, Nerd Font text via `cairo_show_text`, and
+`conky_parse()` all work on it. A `grim` screenshot confirmed the output reaches
+the screen, so this is not merely "the calls return without error".
+
+**Conky renders as a real toplevel.** With `own_window_type = 'normal'` the
+window appears in `hyprctl clients` with `class=conky`, floating, on a normal
+workspace, which is what makes a Hyprland `windowrule` able to place it. The
+existing desktop-layer config uses `own_window_type = 'desktop'`, which is a
+layer-surface at level 0 and cannot be assigned to a workspace at all.
+
+**Cairo output covers `conky.text`.** A `conky.text` of `hello` did not appear
+under the Cairo drawing. `conky.text` is therefore left empty.
+
+## Architecture
+
+ conky.conf.in UDT-templated config: @ROLE@ placeholders, lua_load
+ dashboard.lua entry point; owns the layout table and the grid
+ lib/card.lua Cairo primitives: rounded card, text, gauge
+ lib/data.lua /proc and /sys readers
+ widgets/<name>.lua one file per widget
+
+`conky.text` is empty; all drawing happens in `lua_draw_hook_post`.
+
+### Layout: the user owns the order
+
+A single table at the top of `dashboard.lua` is the layout. Reordering widgets
+means editing that table and nothing else.
+
+ -- Layout. Order and position are yours: edit this table, nothing else.
+ -- col/row are grid cells; w/h span cells. Grid auto-sizes to the screen.
+ local layout = {
+ { widget = 'clock', col = 1, row = 1, w = 1, h = 2 },
+ { widget = 'system', col = 2, row = 1, w = 2, h = 1 },
+ { widget = 'weather', col = 2, row = 2, w = 1, h = 1 },
+ { widget = 'network', col = 3, row = 2, w = 1, h = 1 },
+ }
+
+Consequences, and they are the point:
+
+- A widget receives a rectangle and draws inside it. It never knows where it is,
+ so moving it cannot break it.
+- Cell size is derived from the surface dimensions, so the same table works on
+ either monitor.
+- Adding a widget is a new file in `widgets/` plus one row in the table.
+
+Grid cells mean cards snap to the grid; a card cannot sit at an arbitrary pixel
+offset. This was chosen over an absolute-placement escape hatch because cells
+give alignment for free and keep realigning when the grid or the screen changes.
+
+### Widget interface
+
+Every widget exports one function:
+
+ function draw(cr, rect, colors) -- rect = {x, y, w, h}
+
+`rect` is computed by the grid. `colors` is the palette table. A widget draws
+only inside its rect; it does not read the layout, other widgets, or global
+position.
+
+### Palette
+
+No hex literals in Lua. `conky.conf.in` carries the `@HEADING@`, `@LABEL@`,
+`@VALUE@`, `@RULE@`, `@BODY@` placeholders that the existing template already
+uses, and UDT's `bin/udt-palette` fills them from `palette/roles-<scheme>.conf`.
+Lua reads the resulting values from `conky.config` once per draw cycle and hands
+them to widgets as `colors`.
+
+Scheme switching therefore keeps working unchanged: edit
+`~/.config/udt/roles.conf`, run `./install.sh`. The `[conky]` role block already
+exists in every shipped scheme, so no palette file needs touching.
+
+### Data
+
+`lib/data.lua` reads `/proc/stat`, `/proc/meminfo` and `/sys/class/hwmon/*`
+directly, replacing the `${execi ... | grep | awk}` pipelines of the old
+template. Motivation is correctness and cost: those pipelines spawn several
+processes every few seconds.
+
+**hwmon is globbed by its `name` file, never by a fixed index.** Carried over
+verbatim from the old config, where it is the hard-won part:
+
+ /sys/class/hwmon/hwmon*/name -> match exact name -> read tempN_input
+
+Fixed `${hwmon N}` indices drift across kernel and hardware reorders and then
+silently report the wrong chip. Known mapping on this host: CPU TCTL is
+`k10temp` temp1; NVMe is `nvme` temp1; motherboard is `gigabyte_wmi` temp2 and
+temp3 (that chip exposes five unlabeled temps, chosen empirically); GPU (Intel
+Arc B580) is `xe` temp2 package, temp3 vram, fan1 RPM.
+
+These bindings are host-specific and will not port to another machine.
+
+Data that genuinely needs a shell stays a shell call, kept behind a `data.lua`
+function: `playerctl` for MPRIS now-playing, and the weather fetch below.
+
+### Weather
+
+Deferred past the v1 slice, then implemented as a fetch script writing a cache
+file that `data.lua` reads. The dashboard never blocks on the network.
+
+`~/Programming/waybar-weather.py` exists and is the starting point, but it is
+not reusable as-is: it scrapes `weather.com` HTML with `pyquery`, a third-party
+dependency, and screen-scraping breaks whenever the site's markup changes. The
+replacement targets a documented endpoint (`wttr.in` JSON, or an API with a key)
+and is reimplemented rather than copied. The location id in that script is
+personal data and does not move into this repo.
+
+## v1 slice: one card, one widget, end to end
+
+The clock card, shaped after `idea2.png`, and nothing else.
+
+That single card exercises the entire pipeline: UDT renders the template from
+palette roles, Conky loads the Lua, the grid computes a rect, Cairo draws on a
+`conky_surface()`, and Hyprland places the window on the special workspace.
+
+Every widget after it is additive: one file, one table row.
+
+## Hyprland integration
+
+ own_window_class = 'conky-dash'
+
+Distinct from the existing desktop-layer instance's `Conky`, so the two can
+never match each other's rules.
+
+ windowrulev2 = workspace special:dash silent, class:^(conky-dash)$
+ windowrulev2 = fullscreen, class:^(conky-dash)$
+ windowrulev2 = noborder, class:^(conky-dash)$
+
+Toggle, bound to both a keybind and a waybar launcher:
+
+ hyprctl dispatch togglespecialworkspace dash
+
+**Lifetime: always running, started with the session, no hidden-state
+optimization.** Hiding is a workspace switch, so showing is instant and graph
+history survives. Skipping draws while the workspace is hidden was considered
+and rejected as unmeasured: Conky at a 2-3s interval is cheap, and the check
+costs a `hyprctl` call per cycle. Revisit only if idle CPU actually shows up.
+
+## Error handling
+
+**Conky reports a Lua fault as a blank screen and nothing else.** No stderr, no
+log line: a typo in a Cairo call yields an empty dashboard.
+
+So the draw body runs inside `pcall`, and on failure the error string is drawn
+onto the surface in the palette's critical colour. Three lines, and every future
+failure becomes a readable message instead of a black rectangle.
+
+This is the only error handling the dashboard needs; a widget that cannot read
+its data draws a dash, it does not abort the frame.
+
+## Verification
+
+**Parsers:** one runnable check, `assert`-based, run with `lua`. Committed
+fixture text for `/proc/stat`, `/proc/meminfo` and a hwmon `temp*_input` is
+parsed and the results asserted. Parsers are what break silently on a kernel
+change, so they are what gets a test. No framework, no fixtures directory.
+
+**Rendering:** screenshot loop, the one used to verify `conky_surface()`:
+
+ conky -c ./conky.conf &
+ grim -g "$(hyprctl clients -j | jq -r '.[]|select(.class=="conky-dash")|"\(.at[0]),\(.at[1]) \(.size[0])x\(.size[1])"')" cap.png
+
+Cairo correctness is a visual property; a screenshot is the honest check.
+
+## Explicitly out of scope
+
+Per-monitor layout variants. Absolute pixel placement. A configuration UI or
+drag-to-place. Click interaction of any kind. The task list and mic button from
+`idea1.png`. Light-scheme support, which UDT does not have either.
+
+## Open items
+
+Both deferred by design, neither blocks v1.
+
+- Weather source: `wttr.in` versus a keyed API. Decided when the widget is built.
+- Album art via Imlib2 for the media widget, as in `idea2.png`. Needs a check
+ that Imlib2 bindings work on a Wayland `conky_surface()`, which was not tested.
+
+## License
+
+GPLv2 only, matching UDT.
diff --git a/idea1.png b/idea1.png
new file mode 100644
index 0000000..8d76c13
--- /dev/null
+++ b/idea1.png
Binary files differ
diff --git a/idea2.png b/idea2.png
new file mode 100644
index 0000000..184c55c
--- /dev/null
+++ b/idea2.png
Binary files differ