From 79d73cd623039aab12fc0be7d484bc91c4730a65 Mon Sep 17 00:00:00 2001 From: Bernardo Magri Date: Fri, 10 Jul 2026 21:15:36 +0100 Subject: [PATCH] =?UTF-8?q?docs(omarchy):=20#78=20Omarchy=20=E2=86=92=20No?= =?UTF-8?q?marchy=20migrant=20one-pager?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add docs/OMARCHY.md for users coming from Omarchy (VISION § F). Leads with the one real difference — imperative dotfiles vs a declarative flake built via the menu, with rollback through NixOS generations — then maps the deltas: install (ISO/nomarchy-install or MIGRATION.md), a familiar keybindings table, theming (SUPER+T / nomarchy-theme-sync), installing software (home.packages / nix shell, no AUR), and update+rollback (nomarchy-pull/-rebuild/-home, boot-menu generations, nomarchy-doctor). Registered in docs/README.md; VISION § F marked shipped. The Nomarchy side is grounded in the code: keybindings pulled from keybinds.nix, and every cited command (7), the nsearch alias, and the named theme slugs (gruvbox/rose-pine/nord) verified to exist. Omarchy-side claims kept to known facts (Arch, dotfiles, pacman/AUR). Verification: V0 (docs-only); commands/slugs/binds checked against the tree. Co-Authored-By: Claude Opus 4.8 --- agent/BACKLOG.md | 18 +++---- agent/JOURNAL.md | 18 +++++++ docs/OMARCHY.md | 125 +++++++++++++++++++++++++++++++++++++++++++++++ docs/README.md | 1 + docs/VISION.md | 2 +- 5 files changed, 152 insertions(+), 12 deletions(-) create mode 100644 docs/OMARCHY.md diff --git a/agent/BACKLOG.md b/agent/BACKLOG.md index 901fd34..3a76e5f 100644 --- a/agent/BACKLOG.md +++ b/agent/BACKLOG.md @@ -150,20 +150,16 @@ _(Identity taste retunes + hand `btop.theme` for white/vantablack/lumon/ ### Docs / narrative -- **Omarchy migrant one-pager** (`VISION § F`) — no Omarchy→Nomarchy guide - exists (MIGRATION.md is NixOS→Nomarchy; RECOVERY is recovery). Omarchy is - the closest sibling and the likeliest source of new users. A short `docs/` - page mapping the deltas: keybindings, the theme system (`nomarchy-theme-sync` - vs Omarchy's), the install path (ISO vs Arch script), and what feels the - same (Hyprland/Waybar). Docs-only, low-risk, adoption-facing. Cost: small. - (Verified 2026-07-10: no "omarchy" mentions in docs beyond VISION's idea.) +_(Omarchy migrant one-pager → shipped 2026-07-10 as **#78**: + `docs/OMARCHY.md` — config-model shift, install, bindings, theming, + packages, update/rollback; verified commands/slugs/binds.)_ ### v1.0 pointer -See **VISION**. Doctor hibernate section promoted → NEXT #77. Open -PROPOSED: Omarchy migrant doc (`§F`); auto time-of-day theme pair (`§D`, -big); NVIDIA wrappers deferred past v1; IR portal (b)/(c) hardware. -Browser default = Chromium; power = PPD. +See **VISION**. Shipped: doctor hibernate #77, Omarchy migrant doc #78. +Open PROPOSED: auto time-of-day theme pair (`§D`, big); NVIDIA wrappers +deferred past v1; IR portal (b)/(c) hardware. Browser default = Chromium; +power = PPD. ## Decisions `[human]` diff --git a/agent/JOURNAL.md b/agent/JOURNAL.md index 4a2f7f0..4478f08 100644 --- a/agent/JOURNAL.md +++ b/agent/JOURNAL.md @@ -17,6 +17,24 @@ Template: --- +## 2026-07-10 — #78 Omarchy migrant doc (docs/OMARCHY.md) +- **Task:** BACKLOG #78 (promoted from PROPOSED) — Omarchy→Nomarchy + one-pager (`VISION § F`). +- **Did:** New `docs/OMARCHY.md`: leads with the config-model shift + (imperative dotfiles → declarative flake + menu, rollback via + generations), then install (ISO/`nomarchy-install` or MIGRATION.md), + a familiar-bindings table, theming (`SUPER+T`/`nomarchy-theme-sync`), + packages (home.packages / `nix shell`, no AUR), update+rollback + (`nomarchy-pull`/`-rebuild`/`-home`, boot-menu generations, + `nomarchy-doctor`). Added to `docs/README.md` map + VISION § F ✓. +- **Verified:** V0 (docs). Grounded Nomarchy side in code: pulled real + binds from `keybinds.nix`; confirmed all 7 cited commands, the `nsearch` + alias, and the named slugs (gruvbox/rose-pine/nord) exist. Kept + Omarchy-side claims to known facts (Arch, dotfiles, pacman/AUR). +- **Pending:** none. +- **Next suggestion:** NEXT head #76 `[blocked:hw]`; last open PROPOSED is + auto time-of-day theme pair (`§D`, `[big]` — needs splitting). + ## 2026-07-10 — #77 doctor hibernate/sleep section (V2 PASS) - **Task:** BACKLOG #77 (promoted from PROPOSED by Bernardo) — read-only hibernate section in nomarchy-doctor (`VISION § C`, #76 follow-on). diff --git a/docs/OMARCHY.md b/docs/OMARCHY.md new file mode 100644 index 0000000..1d4eba7 --- /dev/null +++ b/docs/OMARCHY.md @@ -0,0 +1,125 @@ +# Coming from Omarchy + +Nomarchy and [Omarchy](https://omarchy.org) are cousins: the same +Hyprland + Waybar desktop feel, the same opinionated "beautiful out of the +box," one-command theming, and a keyboard-driven menu. If you liked +Omarchy, you'll be at home here in minutes. + +The one real difference is the **foundation**: + +| | Omarchy | Nomarchy | +|------------|---------|----------| +| Base | Arch Linux | NixOS | +| Config | **imperative** dotfiles you edit in `~/.config`, live | **declarative** — built from a flake; changed via the menu or your `home.nix`/`system.nix` | +| Packages | `pacman` / `yay` / AUR, anytime | `nixpkgs` — added to your flake (no AUR) | +| Recovery | reinstall / restore dotfiles | **every rebuild is a bootable generation** — roll back from the boot menu | + +This page maps the day-to-day deltas. Nothing about the *desktop* has to +be relearned — only *how you change it*. + +--- + +## The one mental shift: declarative, not dotfiles + +In Omarchy you open a file under `~/.config`, save it, and the change is +live. In Nomarchy the whole desktop is **built from your flake**, so you +change it one of two ways: + +1. **The menu** (`SUPER+M`) — the everyday path. It writes the change into + your flake's state and rebuilds for you. You never hand-edit a config + for theming, night light, wallpaper, keyboard layout, power, etc. +2. **Your flake** — for anything the menu doesn't cover, edit + `home.nix` / `system.nix` (a handful of `nomarchy.*` options and plain + Home-Manager/NixOS), then run a rebuild. + +The payoff for the extra indirection: **a bad change never bricks you.** +Every `nomarchy-rebuild` is a new NixOS generation; if one misbehaves, +reboot and pick the previous entry from the boot menu — your files +(`/home`) are never touched. See [RECOVERY.md](RECOVERY.md). + +> Editing `~/.config/hypr/*` by hand won't stick — Home-Manager owns those +> files and rewrites them on the next rebuild. Change the source (menu or +> flake) instead. + +--- + +## Install + +| | | +|---|---| +| **Omarchy** | Run the bootstrap on a fresh Arch install. | +| **Nomarchy** | Boot the ISO and run **`nomarchy-install`** (single-disk UEFI, optional LUKS, hibernation-ready swap). | +| **Already on NixOS?** | Convert in place, no reformat — [MIGRATION.md](MIGRATION.md). | + +--- + +## Keybindings (they'll feel familiar) + +The full, always-current list is one keypress away: **`SUPER+?`** opens the +live cheatsheet — you never have to memorize this table. + +| Key | Action | +|-----|--------| +| `SUPER+Return` | Terminal | +| `SUPER+Space` | App launcher | +| `SUPER+M` | Main menu (theme, network, audio, power, tools…) | +| `SUPER+T` | Theme picker | +| `SUPER+SHIFT+T` | Next wallpaper | +| `SUPER+E` | File manager (yazi) | +| `SUPER+X` | Power menu (lock / suspend / hibernate / reboot …) | +| `SUPER+?` | Keybindings cheatsheet | +| `Print` | Screenshot region → clipboard | +| `SUPER+CTRL+` | Jump straight to a menu module (clipboard `V`, calc `C`, emoji `E`, capture `S`, …) | + +--- + +## Theming + +Both distros reskin everything from one place. In Nomarchy: + +- **`SUPER+T`** (or `nomarchy-menu theme`) — pick from 24 presets with live + previews; it rebuilds and applies to Hyprland, Waybar, the terminal, + btop and GTK/Qt at once. +- Or from a shell: `nomarchy-theme-sync apply ` (e.g. `gruvbox`, + `rose-pine`, `nord`). +- Tweak gaps / rounding / fonts / opacity / icon pack without leaving the + theme system — see [OVERRIDES.md](OVERRIDES.md). One git-tracked JSON + (`theme-state.json`) is the single source of truth. + +--- + +## Installing software + +There is no AUR. Two paths: + +- **Keep it:** add the package to `home.packages` in your flake's + `home.nix`, then `nomarchy-home`. It's now declared, reproducible, and + part of your rollback history. A curated default app set already ships — + you extend the list. +- **Just this once:** `nix shell nixpkgs#` drops you into a shell with + it on `PATH`, gone when you exit — the equivalent of a throwaway install. + +Search with `nsearch ` (`nix search nixpkgs`). + +--- + +## Update & roll back + +| | Omarchy | Nomarchy | +|---|---|---| +| **Update** | update command | `nomarchy-pull` (bump inputs), then `nomarchy-rebuild` (system) + `nomarchy-home` (desktop) | +| **Roll back** | restore dotfiles | reboot → pick the previous **generation** in the boot menu (or a snapper snapshot) | +| **Health check** | — | `nomarchy-doctor` (System › Doctor) — read-only pass/fail sheet, each ✖ shows its fix | + +On a failed rebuild, `nomarchy-rebuild` / `nomarchy-home` print the last +log lines and point you at `nomarchy-doctor` and [RECOVERY.md](RECOVERY.md) +— you're never left guessing. + +--- + +## What's exactly the same + +Hyprland tiling and feel, Waybar, the rofi-driven menu, the blur/rounding +aesthetic, keyboard-first everything, and strong opinionated defaults. The +desktop is the part you already know — this page is only about the NixOS +plumbing underneath. diff --git a/docs/README.md b/docs/README.md index e1b1b10..0145dea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,7 @@ tree for the same facts. | [RECOVERY.md](RECOVERY.md) | Users | Broken theme/desktop/boot → undo | | [OVERRIDES.md](OVERRIDES.md) | Users | Downstream Nix overrides | | [MIGRATION.md](MIGRATION.md) | Users | Existing NixOS → Nomarchy without reinstall | +| [OMARCHY.md](OMARCHY.md) | Users | Coming from Omarchy — bindings/theme/install/config map | ## Related (not under `docs/`) diff --git a/docs/VISION.md b/docs/VISION.md index d13079f..50f489e 100644 --- a/docs/VISION.md +++ b/docs/VISION.md @@ -111,7 +111,7 @@ Reference: [HARDWARE.md](HARDWARE.md) §4–§5, §10. | Idea | Intent | Notes | |------|--------|-------| -| **Omarchy migrant one-pager** | Bindings/theme/install map | `docs/` short guide | +| **Omarchy migrant one-pager** ✓ | Bindings/theme/install map | ✓ shipped `docs/OMARCHY.md` (#78, 2026-07-10) | | **Hardware hall of fame** | Install-tested models; invite DMI PRs | Ties to HARDWARE.md §9 | | **60s demo** | Live → install → theme → menu | Outside repo OK |