From a392bdc1fcaa2c536b8af2307d7ec3e7e60b4c9a Mon Sep 17 00:00:00 2001 From: "s0wlz (Matthias Puchstein)" Date: Wed, 31 Dec 2025 02:53:47 +0100 Subject: [PATCH] docs: document external docs submodules and update ignore list Document the external docs layout under dot_local/share/docs in AGENTS and GEMINI, and drop outdated references to the old hyprland/waybar wiki mirrors. Remove the ignore entries for the previous wiki paths from .chezmoiignore. hypr: switch hyprpaper template to wallpaper blocks Replace preload generation with explicit wallpaper blocks per monitor. waybar: always include custom/alhp module Remove the hostname guard so the module is present on all hosts. --- .chezmoiignore.tmpl | 3 +-- .gitmodules | 9 +++++++++ AGENTS.md | 8 +++++++- GEMINI.md | 8 ++++++++ dot_config/hypr/AGENTS.md | 2 -- dot_config/hypr/hyprpaper.conf.tmpl | 18 +++++------------- dot_config/waybar/AGENTS.md | 1 - dot_config/waybar/config.tmpl | 2 -- dot_local/share/docs/external_chezmoi-docs | 1 + dot_local/share/docs/external_hyprland.wiki | 1 + dot_local/share/docs/external_waybar.wiki | 1 + 11 files changed, 33 insertions(+), 21 deletions(-) create mode 100644 .gitmodules create mode 160000 dot_local/share/docs/external_chezmoi-docs create mode 160000 dot_local/share/docs/external_hyprland.wiki create mode 160000 dot_local/share/docs/external_waybar.wiki diff --git a/.chezmoiignore.tmpl b/.chezmoiignore.tmpl index 3fa0b83..820e21c 100644 --- a/.chezmoiignore.tmpl +++ b/.chezmoiignore.tmpl @@ -31,8 +31,7 @@ .config/MangoHud/** {{- end -}} -.config/hypr/hyprland.wiki/** -.config/waybar/waybar.wiki/** + AGENTS.md GEMINI.md diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..d1184fa --- /dev/null +++ b/.gitmodules @@ -0,0 +1,9 @@ +[submodule "dot_local/share/docs/external_chezmoi-docs"] + path = dot_local/share/docs/external_chezmoi-docs + url = https://github.com/twpayne/chezmoi.git +[submodule "dot_local/share/docs/external_hyprland.wiki"] + path = dot_local/share/docs/external_hyprland.wiki + url = https://github.com/hyprwm/hyprland-wiki.git +[submodule "dot_local/share/docs/external_waybar.wiki"] + path = dot_local/share/docs/external_waybar.wiki + url = https://github.com/Alexays/Waybar.wiki.git diff --git a/AGENTS.md b/AGENTS.md index 0927667..746ea93 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,7 +7,13 @@ This is a chezmoi dotfiles source tree. Key paths: - `dot_profile.tmpl` renders to `~/.profile`. - `.chezmoiscripts/` contains chezmoi hooks (e.g., `run_onchange_*` scripts). - Host-specific variants use `##hostname.` (e.g., `hyprpaper.conf##hostname.owlenlap01`). -- `dot_config/waybar/waybar.wiki/` and `dot_config/hypr/hyprland.wiki/` are mirrored docs with `dot_git/` metadata; treat them as upstream mirrors unless intentionally updating. + +## Documentation +- Docs live under `dot_local/share/docs/` as git submodules and use the `external_` attribute so chezmoi does not interpret their contents. +- `dot_local/share/docs/external_chezmoi-docs` (sparse checkout `assets/chezmoi.io`) renders to `~/.local/share/docs/chezmoi-docs`. +- `dot_local/share/docs/external_hyprland.wiki` (sparse checkout `content`) renders to `~/.local/share/docs/hyprland.wiki`. +- `dot_local/share/docs/external_waybar.wiki` renders to `~/.local/share/docs/waybar.wiki`. +- Waybar manual pages are not stored in the repo; use `man 5 waybar` and `man 5 waybar-` for module docs. ## Chezmoi Config (chezmoi.toml) - Source of truth: `~/.config/chezmoi/chezmoi.toml` (not tracked here). diff --git a/GEMINI.md b/GEMINI.md index b12ba4e..3f20256 100644 --- a/GEMINI.md +++ b/GEMINI.md @@ -22,9 +22,17 @@ The directory structure follows standard `chezmoi` conventions: * **`zsh/`**: Zsh configuration, including `dot_zshrc` (mapped to `~/.config/zsh/.zshrc`). * **`waybar/`**: Waybar configuration and styles. * **`dot_local/`**: Maps to `~/.local/`. Contains scripts and local data. + * **`dot_local/share/docs/`**: Local docs area populated by git submodules using the `external_` attribute (renders to `~/.local/share/docs/`). * **`.chezmoiscripts/`**: Contains scripts that run when `chezmoi apply` is executed (e.g., `run_onchange_...`). * **`dot_profile.tmpl`**: A template that renders to `~/.profile`, handling environment variables. It uses tags (e.g., `dev`, `desktop`) to conditionally include configurations. +## Documentation + +* **Chezmoi docs:** `dot_local/share/docs/external_chezmoi-docs` (sparse checkout `assets/chezmoi.io`) renders to `~/.local/share/docs/chezmoi-docs`. +* **Hyprland wiki:** `dot_local/share/docs/external_hyprland.wiki` (sparse checkout `content`) renders to `~/.local/share/docs/hyprland.wiki`. +* **Waybar wiki:** `dot_local/share/docs/external_waybar.wiki` renders to `~/.local/share/docs/waybar.wiki`. +* **Waybar man pages:** Not stored in the repo; use `man 5 waybar` and `man 5 waybar-`. + ## Usage This directory is the **source of truth**. Do not edit files directly in `~/.config` if they are managed here; your changes will be overwritten. diff --git a/dot_config/hypr/AGENTS.md b/dot_config/hypr/AGENTS.md index 9fcb241..4ebafe2 100644 --- a/dot_config/hypr/AGENTS.md +++ b/dot_config/hypr/AGENTS.md @@ -7,7 +7,6 @@ This directory is the Hyprland portion of a chezmoi dotfiles source tree. Key pa - `dot_profile.tmpl` renders to `~/.profile`. - `.chezmoiscripts/` holds chezmoi hooks such as `run_onchange_*`. - Host-specific variants use `##hostname.` (e.g., `hyprpaper.conf##hostname.owlenlap01`). -- `dot_config/hypr/hyprland.wiki/` is a mirrored docs subtree; treat it as upstream unless intentionally updating. Hyprland configuration lives here in `hyprland.conf`, with modular includes under `hyprland.d/` and related configs like `hypridle.conf`, `hyprlock.conf.tmpl`, and `hyprpaper.conf.tmpl`. @@ -72,4 +71,3 @@ No established Git history. Use concise, imperative commit subjects with optiona - Screenshots for visible UI changes. ## Agent-Specific Notes -When editing mirrored docs under `dot_config/hypr/hyprland.wiki/`, treat them as upstream mirrors unless explicitly asked to update. diff --git a/dot_config/hypr/hyprpaper.conf.tmpl b/dot_config/hypr/hyprpaper.conf.tmpl index 33e7508..2e0630c 100644 --- a/dot_config/hypr/hyprpaper.conf.tmpl +++ b/dot_config/hypr/hyprpaper.conf.tmpl @@ -2,19 +2,11 @@ splash = true splash_offset = 2.0 ipc = true -{{- $preloads := dict -}} -{{- range .monitors -}} - {{- if .wallpaper -}} - {{- $_ := set $preloads .wallpaper 1 -}} - {{- end -}} -{{- end -}} - -{{- range $path, $_ := $preloads }} -preload = {{ $path }} -{{- end }} - {{- range .monitors }} {{- if .wallpaper }} -wallpaper = {{ .name }}, {{ .wallpaper }} +wallpaper { + monitor = {{ .name }} + path = {{ .wallpaper }} +} {{- end }} -{{- end }} \ No newline at end of file +{{- end }} diff --git a/dot_config/waybar/AGENTS.md b/dot_config/waybar/AGENTS.md index c289191..d9b161d 100644 --- a/dot_config/waybar/AGENTS.md +++ b/dot_config/waybar/AGENTS.md @@ -3,7 +3,6 @@ ## Project Structure & Module Organization This is a chezmoi dotfiles source tree scoped to Waybar. The current directory maps to `~/.config/waybar/` on apply. - `dot_config/waybar/` contains Waybar config, style, and module files. -- `dot_config/waybar/waybar.wiki/` is a mirrored upstream doc set with `dot_git/` metadata; avoid editing unless intentionally updating the mirror. - Host-specific variants use `##hostname.` suffixes (e.g., `config##hostname.laptop`). ## Chezmoi Config (chezmoi.toml) diff --git a/dot_config/waybar/config.tmpl b/dot_config/waybar/config.tmpl index fbd5057..86d5838 100644 --- a/dot_config/waybar/config.tmpl +++ b/dot_config/waybar/config.tmpl @@ -16,9 +16,7 @@ "modules-left": [ "clock", "custom/swaync", - {{- if eq .chezmoi.hostname "owlenpc00" }} "custom/alhp", - {{- end }} "hyprland/workspaces" ], diff --git a/dot_local/share/docs/external_chezmoi-docs b/dot_local/share/docs/external_chezmoi-docs new file mode 160000 index 0000000..b2e13cb --- /dev/null +++ b/dot_local/share/docs/external_chezmoi-docs @@ -0,0 +1 @@ +Subproject commit b2e13cb9280d305ad5808cee6350685e0d48ffec diff --git a/dot_local/share/docs/external_hyprland.wiki b/dot_local/share/docs/external_hyprland.wiki new file mode 160000 index 0000000..632b8a1 --- /dev/null +++ b/dot_local/share/docs/external_hyprland.wiki @@ -0,0 +1 @@ +Subproject commit 632b8a1c28efe365cb67b6298933fd2249bdb9f1 diff --git a/dot_local/share/docs/external_waybar.wiki b/dot_local/share/docs/external_waybar.wiki new file mode 160000 index 0000000..ed4deba --- /dev/null +++ b/dot_local/share/docs/external_waybar.wiki @@ -0,0 +1 @@ +Subproject commit ed4debace66ba7eabf02289e5c052c1260e5243f