docs(setup): version aliases.zsh + gitconfig.txt under docs/setup/dotfiles

80-dotfiles.sh was reading notes/aliases.zsh and notes/gitconfig.txt, but notes/ is gitignored - fresh clones on the dev VM hit "file not found" and the script aborted. Move both templates to docs/setup/dotfiles/ where they ship with every clone. gitconfig.txt's [user] block now carries placeholder identity (your name / your.email@example.com) instead of the original author's identity - the script overlays the prompted values at install time so the file content doesn't matter functionally, but the placeholders read more clearly as "fill me in". 80-dotfiles.sh source paths flipped from $REPO_ROOT/notes/... to $REPO_ROOT/docs/setup/dotfiles/.... Step-3 table row, §8.4 (dotfiles repo appendix), and the setup README index updated accordingly. New "dotfiles/" section in the setup README documents the folder. The notes/aliases.zsh and notes/gitconfig.txt on existing dev workstations are unaffected - those files live outside the repo and this PR doesn't touch them.
2026-05-24 21:22:08 +02:00
parent 1d11db9f36
commit 43c54616d8
5 changed files with 96 additions and 8 deletions
@@ -24,7 +24,16 @@ Modular setup scripts called from the doc above. Each is idempotent, each can be
 | [`50-docker.sh`](scripts/50-docker.sh)               | Docker CE + compose plugin from docker.com apt repo + user added to `docker` group + service enabled at boot.                                                                    |
 | [`60-tuning.sh`](scripts/60-tuning.sh)               | inotify watches → 524288, optional 4 GB swapfile, optional hostname rename (only prompts if generic).                                                                            |
 | [`70-hardening.sh`](scripts/70-hardening.sh)         | Best-effort UFW + unattended-upgrades + fail2ban (opt-in) + sshd hardening drop-in. Probes before applying — skips done items, prompts before each install.                      |
-| [`80-dotfiles.sh`](scripts/80-dotfiles.sh)           | Symlinks `notes/aliases.zsh` → `~/.oh-my-zsh/custom/aliases.zsh`. Copies `notes/gitconfig.txt` to `~/.gitconfig` with prompted identity.                                         |
+| [`80-dotfiles.sh`](scripts/80-dotfiles.sh)           | Symlinks `docs/setup/dotfiles/aliases.zsh` → `~/.oh-my-zsh/custom/aliases.zsh`. Copies `docs/setup/dotfiles/gitconfig.txt` to `~/.gitconfig` with prompted identity.             |
+
+## `dotfiles/`
+
+Project-wide dotfile templates installed by [`80-dotfiles.sh`](scripts/80-dotfiles.sh). Versioned so a fresh clone has everything it needs — `notes/` is gitignored and was the wrong home for these.
+
+| File                                      | Purpose                                                                                                                                                                      |
+| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`aliases.zsh`](dotfiles/aliases.zsh)     | Project-wide zsh aliases, symlinked into `~/.oh-my-zsh/custom/aliases.zsh`. Edit here, all devs pick it up on restart.                                                       |
+| [`gitconfig.txt`](dotfiles/gitconfig.txt) | Base `~/.gitconfig` template (aliases, colour, default branch, editor). Identity (`user.name` / `user.email`) is prompted at install and overlaid via `git config --global`. |

 ## `systemd/`