Skip to content

Commit 1d0e1a5

Browse files
committed
docs: update repo structure across READMEs
1 parent 095fa56 commit 1d0e1a5

4 files changed

Lines changed: 17 additions & 90 deletions

File tree

README.md

Lines changed: 12 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -134,90 +134,18 @@ The repository is organized using [flake-parts](https://github.com/hercules-ci/f
134134

135135
```
136136
.
137-
├── .claude/ # Claude AI assistant configuration
138-
│ ├── commands/
139-
│ │ └── openspec/
140-
│ ├── .mcp.json
141-
│ ├── CLAUDE.md
142-
│ └── settings.json
143-
├── .github/ # GitHub Actions workflows & funding
144-
│ ├── workflows/
145-
│ └── FUNDING.yml
146-
├── assets/ # Images and visual assets
147-
│ ├── topology/
148-
│ │ ├── main.svg
149-
│ │ └── network.svg
150-
│ ├── home_graph.png
151-
│ ├── qezta.gif
152-
│ └── qezta.png
153-
├── common/ # Shared configurations across all platforms
154-
│ ├── all/ # Common to all configurations
155-
│ ├── home/ # Common home-manager configurations
156-
│ └── hosts/ # Common host configurations
157-
│ ├── all/
158-
│ ├── darwin/
159-
│ ├── droid/
160-
│ ├── iso/
161-
│ └── nixos/
162-
├── flake/ # Flake-parts module definitions
163-
│ ├── actions/ # GitHub Actions definitions
164-
│ ├── topology/ # Network topology configuration
165-
│ ├── checks.nix
166-
│ ├── devshells.nix
167-
│ ├── formatters.nix
168-
│ ├── iso-packages.nix
169-
│ └── mkCfg.nix # Universal host builder
170-
├── home/ # Home-manager modules by category
171-
│ ├── comms/ # Communication (email, IRC, newsboat)
172-
│ ├── dev/ # Development tools (JS, Python, cloud)
173-
│ ├── gui/ # GUI applications and desktop managers
174-
│ ├── media/ # Media tools (image, video, music)
175-
│ ├── tools/ # Utilities (privacy, productivity, keyboard)
176-
│ ├── tty/ # Terminal tools (editors, shells, multiplexers)
177-
│ └── web/ # Web browsers and related tools
178-
├── hosts/ # Platform-specific host configurations
179-
│ ├── darwin/ # macOS hosts (nix-darwin)
180-
│ │ └── L1/
181-
│ ├── droid/ # Android hosts (nix-on-droid)
182-
│ │ └── M1/
183-
│ ├── iso/ # ISO configurations
184-
│ │ ├── iso/
185-
│ │ └── t2-iso/
186-
│ └── nixos/ # NixOS hosts
187-
│ ├── L2/
188-
│ └── WSL/
189-
├── lib/ # Custom Nix utility functions
190-
│ └── custom.nix
191-
├── modules/ # Custom NixOS/home-manager modules
192-
│ ├── home/
193-
│ └── hosts/
194-
│ └── darwin/
195-
├── openspec/ # OpenSpec project documentation
196-
│ ├── AGENTS.md
197-
│ └── project.md
198-
├── overlays/ # Nix package overlays
199-
│ └── custom.nix
200-
├── pkgs/ # Custom package derivations
201-
│ ├── custom/ # Custom derivations
202-
│ └── darwin/ # macOS-specific packages
203-
├── templates/ # Nix flake templates
204-
│ └── vanilla/
205-
├── utils/ # Build and rebuild scripts
206-
│ ├── common.sh
207-
│ ├── home_rebuild.sh
208-
│ └── hosts_rebuild.sh
209-
├── .editorconfig
210-
├── .envrc
211-
├── .gitattributes
212-
├── .gitignore
213-
├── AGENTS.md # AI agent instructions
214-
├── CODEOWNERS
215-
├── flake.lock
216-
├── flake.nix # Main flake entry point
217-
├── LICENSE
218-
├── README.md
219-
├── SECURITY.md
220-
└── shell.nix
137+
├── flake/ # flake-parts modules — mkCfg, devshells, checks, actions, topology
138+
├── common/ # shared layers: all/, home/, hosts/{all,darwin,droid,iso,nixos}/
139+
├── hosts/ # per-host overrides: darwin/L1, nixos/{L2,T2,WSL}, droid/M1, iso/
140+
├── home/ # home-manager modules by domain: tty/ gui/ tools/ media/ comms/ dev/ web/
141+
├── modules/ # reusable NixOS/HM/darwin modules
142+
├── overlays/ # nixpkgs overlays (custom, customDarwin)
143+
├── pkgs/ # derivations: custom/ and darwin/
144+
├── lib/ # custom Nix utility functions (palette, scanPaths, …)
145+
├── utils/ # rebuild wrapper scripts
146+
├── templates/ # flake templates (vanilla)
147+
├── assets/ # topology SVGs, wallpapers, profile graph
148+
└── flake.nix # entry point — inputs, nixConfig, flake-parts wiring
221149
```
222150

223151
## Theme Pipeline

flake/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,13 @@ The pkgs handed to each config is extended with `master` / `stable` channels (an
3838

3939
## Contents
4040

41+
- **apps.nix** - Runnable flake app outputs (`tty`, `desktop` shells)
42+
- **checks.nix** - Pre-commit hooks
4143
- **devshells.nix** - Development environment (`nix develop`)
4244
- **formatters.nix** - Code formatting (`nix fmt`: alejandra, deadnix, statix)
43-
- **checks.nix** - Pre-commit hooks
44-
- **mkCfg.nix** - Universal host builder (nixos/darwin/droid/home)
4545
- **iso-packages.nix** - ISO build packages
46-
- **topology/** - Infrastructure visualization (nix-topology)
47-
- default.nix - Topology module exports
48-
- global.nix - Global topology definitions
46+
- **mkCfg.nix** - Universal host builder (nixos/darwin/droid/home)
47+
- **topology.nix** - Infrastructure visualization (nix-topology)
4948
- **actions/** - GitHub Actions workflows
5049
- default.nix - Actions module exports
5150
- darwin-build.nix - macOS build actions

home/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Home-manager modules organized by category.
66

77
```
88
home/
9-
├── ai/ # AI/ML tools
109
├── comms/ # Email, IRC, RSS
1110
├── dev/ # Development (JS, Python, cloud)
1211
├── gui/ # GUI apps, desktop managers

hosts/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ hosts/
1010
│ └── L1/ # x86_64-darwin workstation
1111
├── nixos/ # NixOS systems
1212
│ ├── L2/ # x86_64-linux desktop
13+
│ ├── T2/ # x86_64-linux T2 MacBook (Apple T2 chip)
1314
│ └── WSL/ # x86_64-linux WSL2
1415
├── droid/ # Android (nix-on-droid)
1516
│ └── M1/

0 commit comments

Comments
 (0)