docs: add ROADMAP.md + SCRIPTS.md, retire TODO.md
ROADMAP.md is the durable mid-term plan: vision, guardrails, Now/Next/ Later board, and seven pillars (audit, installer, power/presets, onboarding/docs, test/CI/release, process). SCRIPTS.md is the scaffolding for the Pillar 3 script & menu audit — methodology, generator commands, and a snapshot of currently orphaned callers. The two open items in TODO.md (software-profile multi-select, richer disk metadata) move into the roadmap's Now column; the rest of TODO.md was already shipped, so the file is removed. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
84
docs/SCRIPTS.md
Normal file
84
docs/SCRIPTS.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Nomarchy Script & Menu Audit
|
||||
|
||||
This is the working table for [Pillar 3 of the roadmap](ROADMAP.md#3-pillar-script--menu-audit). It catalogues every `nomarchy-*` script, its callers, and an action tag.
|
||||
|
||||
> **Status as of writing:** scaffolding only. Phase A (the inventory PR) has not yet populated this table — see the roadmap for the methodology. Add rows as you triage.
|
||||
|
||||
## Status legend
|
||||
|
||||
- `kept` — works on Nomarchy, no change needed.
|
||||
- `port-from-omarchy` — exists upstream, needs adapting (drop pacman/yay/AUR, repath to NixOS, talk to `nomarchy.system.*` options).
|
||||
- `delete-dead` — neither used nor needed; remove and update callers.
|
||||
- `stub-with-notify` — temporarily replaced with a `notify-send "Not yet implemented in Nomarchy"` until real work is scheduled.
|
||||
- `unknown` — needs a deeper look.
|
||||
|
||||
## Generating the inventory
|
||||
|
||||
The triage PR should regenerate this table by running these commands in repo root:
|
||||
|
||||
```bash
|
||||
# 1. all nomarchy-* scripts
|
||||
find core/system/scripts features/scripts/utils themes/engine/scripts \
|
||||
-type f -name 'nomarchy-*' -printf '%f\t%h\n' | sort
|
||||
|
||||
# 2. all nomarchy-* callers
|
||||
grep -rohE 'nomarchy-[a-z][a-z0-9-]*' core/ features/ themes/ installer/ bin/ \
|
||||
| sort -u
|
||||
|
||||
# 3. orphaned callers (in code but no script)
|
||||
comm -23 <(grep -rohE 'nomarchy-[a-z][a-z0-9-]*' core/ features/ themes/ installer/ bin/ | sort -u) \
|
||||
<(find core/system/scripts features/scripts/utils themes/engine/scripts \
|
||||
-type f -name 'nomarchy-*' -printf '%f\n' | sort -u)
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
| Script | Location | Used by | Status | Notes |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| _(rows go here — Phase A populates this section)_ | | | `unknown` | |
|
||||
|
||||
## Menu items (`features/scripts/utils/nomarchy-menu`)
|
||||
|
||||
The menu has 23 `show_*_menu` functions. List each entry with its target script and tag whether it's wired, broken, or an Omarchy leftover.
|
||||
|
||||
| Submenu | Entry | Calls | Status | Notes |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| _(rows go here — Phase A populates this section)_ | | | `unknown` | |
|
||||
|
||||
## Known orphans (snapshot at audit kickoff)
|
||||
|
||||
These appear as callers in code but have no matching script today. Each needs triage:
|
||||
|
||||
- `nomarchy-backup`
|
||||
- `nomarchy-debug`
|
||||
- `nomarchy-dryrun`
|
||||
- `nomarchy-font`
|
||||
- `nomarchy-font-selector`
|
||||
- `nomarchy-install`
|
||||
- `nomarchy-install-docker-dbs`
|
||||
- `nomarchy-installer-vm`
|
||||
- `nomarchy-luks`
|
||||
- `nomarchy-manual`
|
||||
- `nomarchy-pkg`
|
||||
- `nomarchy-pkg-aur-add`
|
||||
- `nomarchy-pkg-drop`
|
||||
- `nomarchy-pkg-install`
|
||||
- `nomarchy-plymouth`
|
||||
- `nomarchy-refresh-hyprland`
|
||||
- `nomarchy-refresh-waybar`
|
||||
- `nomarchy-reinstall`
|
||||
- `nomarchy-rollback`
|
||||
- `nomarchy-screenrecord-filename`
|
||||
- `nomarchy-sddm-theme`
|
||||
- `nomarchy-skill`
|
||||
- `nomarchy-theme`
|
||||
- `nomarchy-theme-next`
|
||||
- `nomarchy-theme-selector`
|
||||
- `nomarchy-themes-no-images`
|
||||
- `nomarchy-update-firmware`
|
||||
- `nomarchy-upload-log`
|
||||
- `nomarchy-version`
|
||||
- `nomarchy-vm`
|
||||
- `nomarchy-wallpaper`
|
||||
|
||||
(Re-run the generator to refresh this list before each audit batch — the snapshot above is from `2026-04-25`.)
|
||||
Reference in New Issue
Block a user