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.
This commit is contained in:
@@ -31,8 +31,7 @@
|
||||
.config/MangoHud/**
|
||||
{{- end -}}
|
||||
|
||||
.config/hypr/hyprland.wiki/**
|
||||
.config/waybar/waybar.wiki/**
|
||||
|
||||
|
||||
AGENTS.md
|
||||
GEMINI.md
|
||||
|
||||
9
.gitmodules
vendored
Normal file
9
.gitmodules
vendored
Normal file
@@ -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
|
||||
@@ -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.<name>` (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-<module>` for module docs.
|
||||
|
||||
## Chezmoi Config (chezmoi.toml)
|
||||
- Source of truth: `~/.config/chezmoi/chezmoi.toml` (not tracked here).
|
||||
|
||||
@@ -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-<module>`.
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -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.<name>` (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.
|
||||
|
||||
@@ -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 }}
|
||||
{{- end }}
|
||||
|
||||
@@ -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.<name>` suffixes (e.g., `config##hostname.laptop`).
|
||||
|
||||
## Chezmoi Config (chezmoi.toml)
|
||||
|
||||
@@ -16,9 +16,7 @@
|
||||
"modules-left": [
|
||||
"clock",
|
||||
"custom/swaync",
|
||||
{{- if eq .chezmoi.hostname "owlenpc00" }}
|
||||
"custom/alhp",
|
||||
{{- end }}
|
||||
"hyprland/workspaces"
|
||||
],
|
||||
|
||||
|
||||
1
dot_local/share/docs/external_chezmoi-docs
Submodule
1
dot_local/share/docs/external_chezmoi-docs
Submodule
Submodule dot_local/share/docs/external_chezmoi-docs added at b2e13cb928
1
dot_local/share/docs/external_hyprland.wiki
Submodule
1
dot_local/share/docs/external_hyprland.wiki
Submodule
Submodule dot_local/share/docs/external_hyprland.wiki added at 632b8a1c28
1
dot_local/share/docs/external_waybar.wiki
Submodule
1
dot_local/share/docs/external_waybar.wiki
Submodule
Submodule dot_local/share/docs/external_waybar.wiki added at ed4debace6
Reference in New Issue
Block a user