Skip to content

Commit a3074bf

Browse files
Bad3rBad3r
authored
docs(paths): migrate local mirror references to /data/git (#81)
## Summary - migrate local mirror path references from `$HOME/git/...` to `/data/git/...` in AGENTS and docs pages - keep documentation aligned with the active mirror root layout ## Test plan - `git -C /home/vx/trees/nixos/docs-data-git-path-migration status --short` - `git -C /home/vx/trees/nixos/docs-data-git-path-migration submodule update --init --recursive` - `nix develop -c pre-commit run --all-files --hook-stage manual`
2 parents eae16b2 + 65b9ab4 commit a3074bf

6 files changed

Lines changed: 67 additions & 67 deletions

File tree

‎AGENTS.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,10 @@ PR body should include:
236236

237237
### Repository Maintenance
238238

239-
| Trigger | Command | Preconditions | Post-check |
240-
| ------------------- | ----------------------------------------------- | ---------------------------------------------- | ------------------------------------------ |
241-
| Remove files safely | `rip <path>` | File is intended for deletion. | Confirm expected deletion in `git status`. |
242-
| Mirror updates | `nix develop -c ghq get <repo>` or `ghq update` | Shared GHQ root configured; network available. | Mirror updated under `$HOME/git/<repo>`. |
239+
| Trigger | Command | Preconditions | Post-check |
240+
| ------------------- | ----------------------------------------------- | ---------------------------------------------- | ------------------------------------------------ |
241+
| Remove files safely | `rip <path>` | File is intended for deletion. | Confirm expected deletion in `git status`. |
242+
| Mirror updates | `nix develop -c ghq get <repo>` or `ghq update` | Shared GHQ root configured; network available. | Mirror updated under `/data/git/{owner}-{repo}`. |
243243

244244
### Troubleshooting
245245

@@ -313,19 +313,19 @@ Pause, summarize the issue, and ask `vx` for direction.
313313

314314
## Local Mirrors
315315

316-
| Name | Path | Use When |
317-
| -------------- | -------------------------- | -------------------------------------------------------------- |
318-
| Stylix | `$HOME/git/stylix` | Inspect source or apply local patches. |
319-
| Home Manager | `$HOME/git/home-manager` | Review module behavior or backport fixes. |
320-
| i3 Docs | `$HOME/git/i3wm-docs` | Reference i3 documentation offline. |
321-
| nixpkgs | `$HOME/git/nixpkgs` | Inspect/patch upstream expressions. |
322-
| nixos-hardware | `$HOME/git/nixos-hardware` | Pull hardware profiles and troubleshoot host hardware options. |
323-
| nixvim | `$HOME/git/nixvim` | Examine NixVim modules and options. |
324-
| treefmt-nix | `$HOME/git/treefmt-nix` | Adjust formatter behavior or pinning. |
325-
| git-hooks.nix | `$HOME/git/git-hooks.nix` | Update hook definitions or debug pre-commit failures. |
326-
| sops-nix | `$HOME/git/sops-nix` | Manage encrypted secret integrations. |
327-
| import-tree | `$HOME/git/import-tree` | Review/extend auto-loading behavior. |
328-
| files module | `$HOME/git/files` | Update generated artifact sources (e.g., `.gitignore`). |
316+
| Name | Path | Use When |
317+
| -------------- | -------------------------------------- | -------------------------------------------------------------- |
318+
| Stylix | `/data/git/nix-community-stylix` | Inspect source or apply local patches. |
319+
| Home Manager | `/data/git/nix-community-home-manager` | Review module behavior or backport fixes. |
320+
| i3 Docs | `/data/git/i3-i3.github.io` | Reference i3 documentation offline. |
321+
| nixpkgs | `/data/git/NixOS-nixpkgs` | Inspect/patch upstream expressions. |
322+
| nixos-hardware | `/data/git/NixOS-nixos-hardware` | Pull hardware profiles and troubleshoot host hardware options. |
323+
| nixvim | `/data/git/nix-community-nixvim` | Examine NixVim modules and options. |
324+
| treefmt-nix | `/data/git/numtide-treefmt-nix` | Adjust formatter behavior or pinning. |
325+
| git-hooks.nix | `/data/git/cachix-git-hooks.nix` | Update hook definitions or debug pre-commit failures. |
326+
| sops-nix | `/data/git/Mic92-sops-nix` | Manage encrypted secret integrations. |
327+
| import-tree | `/data/git/vic-import-tree` | Review/extend auto-loading behavior. |
328+
| files module | `/data/git/mightyiam-files` | Update generated artifact sources (e.g., `.gitignore`). |
329329

330330
## MCP Tools
331331

‎CLAUDE.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ The `build.sh` script performs full validation (format, hooks, flake check) befo
240240
| Trigger | Command | Preconditions | Post-check |
241241
| -------------------- | ----------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------- |
242242
| Remove files safely | `rip <path>` | Ensure file is tracked or intended for deletion. | Confirm `git status` shows deletion; revert if mistaken. |
243-
| Mirror updates (ghq) | `nix develop -c ghq get <repo>` or `ghq update` | Shared GHQ root configured; ensure network access. | Mirror updated under `$HOME/git/<repo>`. |
243+
| Mirror updates (ghq) | `nix develop -c ghq get <repo>` or `ghq update` | Shared GHQ root configured; ensure network access. | Mirror updated under `/data/git/<repo>`. |
244244

245245
### Troubleshooting
246246

@@ -314,19 +314,19 @@ Pause, summarize the situation, and ask vx for direction before proceeding.
314314

315315
## Local Mirrors
316316

317-
| Name | Path | Use When |
318-
| -------------- | -------------------------- | ----------------------------------------------------------------- |
319-
| Stylix | `$HOME/git/stylix` | Inspect Stylix source or apply local patches. |
320-
| Home Manager | `$HOME/git/home-manager` | Review module behaviors or backport fixes. |
321-
| i3 Docs | `$HOME/git/i3wm-docs` | Reference i3 window manager documentation offline. |
322-
| nixpkgs | `$HOME/git/nixpkgs` | Vendor patches or inspect upstream expressions. |
323-
| nixos-hardware | `$HOME/git/nixos-hardware` | Pull hardware profiles or troubleshoot hardware-specific options. |
324-
| nixvim | `$HOME/git/nixvim` | Examine NixVim modules and options. |
325-
| treefmt-nix | `$HOME/git/treefmt-nix` | Adjust formatting behavior or version pins. |
326-
| git-hooks.nix | `$HOME/git/git-hooks.nix` | Update hook definitions or debug pre-commit failures. |
327-
| sops-nix | `$HOME/git/sops-nix` | Manage encrypted secrets integrations. |
328-
| import-tree | `$HOME/git/import-tree` | Review import-tree functionality or extend module auto-loading. |
329-
| files module | `$HOME/git/files` | Modify sources that generate repo artefacts (e.g., `.gitignore`). |
317+
| Name | Path | Use When |
318+
| -------------- | -------------------------------------- | ----------------------------------------------------------------- |
319+
| Stylix | `/data/git/nix-community-stylix` | Inspect Stylix source or apply local patches. |
320+
| Home Manager | `/data/git/nix-community-home-manager` | Review module behaviors or backport fixes. |
321+
| i3 Docs | `/data/git/i3-i3.github.io` | Reference i3 window manager documentation offline. |
322+
| nixpkgs | `/data/git/NixOS-nixpkgs` | Vendor patches or inspect upstream expressions. |
323+
| nixos-hardware | `/data/git/NixOS-nixos-hardware` | Pull hardware profiles or troubleshoot hardware-specific options. |
324+
| nixvim | `/data/git/nix-community-nixvim` | Examine NixVim modules and options. |
325+
| treefmt-nix | `/data/git/numtide-treefmt-nix` | Adjust formatting behavior or version pins. |
326+
| git-hooks.nix | `/data/git/cachix-git-hooks.nix` | Update hook definitions or debug pre-commit failures. |
327+
| sops-nix | `/data/git/Mic92-sops-nix` | Manage encrypted secrets integrations. |
328+
| import-tree | `/data/git/vic-import-tree` | Review import-tree functionality or extend module auto-loading. |
329+
| files module | `/data/git/mightyiam-files` | Modify sources that generate repo artefacts (e.g., `.gitignore`). |
330330

331331
## MCP Tools
332332

‎docs/architecture/06-reference.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ Available after `nix develop`:
9595

9696
## Resource Links
9797

98-
| Resource | Location |
99-
| ------------------- | ---------------------------------------- |
100-
| NixOS manual mirror | `nixos-manual/` |
101-
| Home Manager manual | `/home/vx/git/home-manager/docs/manual/` |
102-
| Stylix source | `/home/vx/git/stylix` |
103-
| nixpkgs | `/home/vx/git/nixpkgs` |
104-
| sops-nix | `/home/vx/git/sops-nix` |
105-
| import-tree | `/home/vx/git/import-tree` |
98+
| Resource | Location |
99+
| ------------------- | --------------------------------------------------- |
100+
| NixOS manual mirror | `nixos-manual/` |
101+
| Home Manager manual | `/data/git/nix-community-home-manager/docs/manual/` |
102+
| Stylix source | `/data/git/nix-community-stylix` |
103+
| nixpkgs | `/data/git/NixOS-nixpkgs` |
104+
| sops-nix | `/data/git/Mic92-sops-nix` |
105+
| import-tree | `/data/git/vic-import-tree` |
106106

107107
## Next Steps
108108

‎docs/guides/apps-module-style-guide.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -353,10 +353,10 @@ programs = {
353353

354354
```bash
355355
# Check local mirror
356-
ls "~/git/home-manager/modules/programs/<tool>.nix"
356+
ls /data/git/nix-community-home-manager/modules/programs/<tool>.nix
357357

358358
# Or search for the program
359-
grep -r "programs\.<tool>" ~/git/home-manager/modules/programs/
359+
grep -r "programs\.<tool>" /data/git/nix-community-home-manager/modules/programs/
360360
```
361361

362362
If HM support exists, continue to step 6. Otherwise, skip to step 8.
@@ -368,7 +368,7 @@ Create `modules/hm-apps/<tool>.nix`. HM modules **must** guard against enabling
368368
**Before writing the module**, check if the HM module's package option is nullable:
369369

370370
```bash
371-
grep -A3 "package.*=" ~/git/home-manager/modules/programs/<tool>.nix
371+
grep -A3 "package.*=" /data/git/nix-community-home-manager/modules/programs/<tool>.nix
372372
# Look for: nullable = true;
373373
```
374374

@@ -437,7 +437,7 @@ extraAppNames = [
437437

438438
```bash
439439
# Check if stylix supports the app
440-
grep -r "<tool>" ~/git/stylix/modules/
440+
grep -r "<tool>" /data/git/nix-community-stylix/modules/
441441
```
442442

443443
### 9. Add Stylix Configuration (if supported)
@@ -568,19 +568,19 @@ This pattern aligns with CLAUDE.md guidance: "Use `lib.hasAttrByPath` + `lib.get
568568

569569
### Home Manager
570570

571-
| Check | Command |
572-
| ------------------- | ----------------------------------------------------------------------- |
573-
| Module exists | `ls ~/git/home-manager/modules/programs/<tool>.nix` |
574-
| Search by name | `grep -r "programs\.<tool>" ~/git/home-manager/modules/` |
575-
| Firefox derivatives | Check `~/git/home-manager/modules/programs/firefox/mkFirefoxModule.nix` |
571+
| Check | Command |
572+
| ------------------- | ----------------------------------------------------------------------------------------- |
573+
| Module exists | `ls /data/git/nix-community-home-manager/modules/programs/<tool>.nix` |
574+
| Search by name | `grep -r "programs\.<tool>" /data/git/nix-community-home-manager/modules/` |
575+
| Firefox derivatives | Check `/data/git/nix-community-home-manager/modules/programs/firefox/mkFirefoxModule.nix` |
576576

577577
### Stylix
578578

579-
| Check | Command |
580-
| ------------------------ | ----------------------------------------- |
581-
| General support | `grep -r "<tool>" ~/git/stylix/modules/` |
582-
| Firefox/Floorp/LibreWolf | `cat ~/git/stylix/modules/firefox/hm.nix` |
583-
| Available options | `cat ~/git/stylix/modules/<tool>/` |
579+
| Check | Command |
580+
| ------------------------ | ----------------------------------------------------------- |
581+
| General support | `grep -r "<tool>" /data/git/nix-community-stylix/modules/` |
582+
| Firefox/Floorp/LibreWolf | `cat /data/git/nix-community-stylix/modules/firefox/hm.nix` |
583+
| Available options | `cat /data/git/nix-community-stylix/modules/<tool>/` |
584584

585585
### NUR Firefox Addons
586586

‎docs/packaging/javascript-packages.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ This guide covers packaging npm, pnpm, and bun-based JavaScript applications in
66

77
These nixpkgs packages demonstrate various patterns for packaging JavaScript applications:
88

9-
| Package | Path | Pattern | When to Use |
10-
| -------------------- | ---------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- |
11-
| **Misskey** | `$HOME/git/nixpkgs/pkgs/by-name/mi/misskey/package.nix` | Copy entire workspace, wrap `pnpm run` | pnpm monorepos with native modules; preserves symlink structure |
12-
| **cspell** | `$HOME/git/nixpkgs/pkgs/by-name/cs/cspell/package.nix` | `pnpmWorkspaces` filter + hoisted reinstall | Monorepos without native modules; minimal closure |
13-
| **synchrony** | `$HOME/git/nixpkgs/pkgs/by-name/sy/synchrony/package.nix` | Simple `cp -r node_modules` | Single-package pnpm projects (non-monorepo) |
14-
| **siyuan** | `$HOME/git/nixpkgs/pkgs/by-name/si/siyuan/package.nix` | `sourceRoot` + `postPatch` to `fetchPnpmDeps` | Monorepo subpackage with lockfile at root |
15-
| **heroic-unwrapped** | `$HOME/git/nixpkgs/pkgs/by-name/he/heroic-unwrapped/package.nix` | `npm_config_nodedir` for native modules | Electron/native addons needing Node headers |
16-
| **tweakcc** | `packages/tweakcc/default.nix` (local) | shamefully-hoist + autoPatchelfHook | ESM apps with prebuilt native addons, external deps |
9+
| Package | Path | Pattern | When to Use |
10+
| -------------------- | ---------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- |
11+
| **Misskey** | `/data/git/NixOS-nixpkgs/pkgs/by-name/mi/misskey/package.nix` | Copy entire workspace, wrap `pnpm run` | pnpm monorepos with native modules; preserves symlink structure |
12+
| **cspell** | `/data/git/NixOS-nixpkgs/pkgs/by-name/cs/cspell/package.nix` | `pnpmWorkspaces` filter + hoisted reinstall | Monorepos without native modules; minimal closure |
13+
| **synchrony** | `/data/git/NixOS-nixpkgs/pkgs/by-name/sy/synchrony/package.nix` | Simple `cp -r node_modules` | Single-package pnpm projects (non-monorepo) |
14+
| **siyuan** | `/data/git/NixOS-nixpkgs/pkgs/by-name/si/siyuan/package.nix` | `sourceRoot` + `postPatch` to `fetchPnpmDeps` | Monorepo subpackage with lockfile at root |
15+
| **heroic-unwrapped** | `/data/git/NixOS-nixpkgs/pkgs/by-name/he/heroic-unwrapped/package.nix` | `npm_config_nodedir` for native modules | Electron/native addons needing Node headers |
16+
| **tweakcc** | `packages/tweakcc/default.nix` (local) | shamefully-hoist + autoPatchelfHook | ESM apps with prebuilt native addons, external deps |
1717

18-
> **Note:** nixpkgs paths reference a local clone at `$HOME/git/nixpkgs`. Clone via `ghq get NixOS/nixpkgs` or adjust paths.
18+
> **Note:** nixpkgs paths reference a local clone at `/data/git/NixOS-nixpkgs`. Clone via `ghq get NixOS/nixpkgs` or adjust paths.
1919
2020
## pnpm Packages
2121

@@ -392,20 +392,20 @@ cp -rL node_modules $out/lib/my-app/
392392
Find pnpm packages in nixpkgs:
393393

394394
```bash
395-
rg -l 'pnpmConfigHook' $HOME/git/nixpkgs/pkgs/by-name
395+
rg -l 'pnpmConfigHook' /data/git/NixOS-nixpkgs/pkgs/by-name
396396
```
397397

398398
Find packages with specific patterns:
399399

400400
```bash
401401
# Monorepo with workspaces
402-
rg 'pnpmWorkspaces' $HOME/git/nixpkgs/pkgs/by-name
402+
rg 'pnpmWorkspaces' /data/git/NixOS-nixpkgs/pkgs/by-name
403403

404404
# Native module handling
405-
rg 'npm_config_nodedir' $HOME/git/nixpkgs/pkgs/by-name
405+
rg 'npm_config_nodedir' /data/git/NixOS-nixpkgs/pkgs/by-name
406406

407407
# Hoisted node_modules
408-
rg 'nodeLinker hoisted' $HOME/git/nixpkgs/pkgs/by-name
408+
rg 'nodeLinker hoisted' /data/git/NixOS-nixpkgs/pkgs/by-name
409409
```
410410

411411
## npm Packages

‎docs/usage/espanso-usage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,4 +331,4 @@ The espanso module is auto-discovered from:
331331
- **Matches Guide**: https://espanso.org/docs/matches/basics/
332332
- **Variables Reference**: https://espanso.org/docs/matches/extensions/
333333
- **nixpkgs Package**: `pkgs/by-name/es/espanso/package.nix`
334-
- **Home Manager Module**: `/home/vx/git/home-manager/modules/services/espanso.nix`
334+
- **Home Manager Module**: `/data/git/nix-community-home-manager/modules/services/espanso.nix`

0 commit comments

Comments
 (0)