Skip to content

Commit

Permalink
docs: update layouts & adding systems
Browse files Browse the repository at this point in the history
  • Loading branch information
isabelroses committed Jan 6, 2025
1 parent 0c9bc76 commit e729820
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 22 deletions.
4 changes: 3 additions & 1 deletion docs/src/config/adding-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To set up a system configuration it must be declared in `/systems/default.nix`.
- default: "x86_64"
- options: "x86_64", "aarch64"

- target:
- class:

- default: "nixos"
- options: "nixos", "darwin", "iso"
Expand All @@ -34,3 +34,5 @@ To set up a system configuration it must be declared in `/systems/default.nix`.

- specialArgs:
- default: "{ }"

Please consult [easy-hosts](https://github.com/isabelroses/easy-hosts) for more information on how to set up a system configuration.
50 changes: 29 additions & 21 deletions docs/src/config/layout.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
- ๐Ÿ  [home](https:/github.com/isabelroses/dotfiles/tree/main//home/) Where all home-manager configurations lie
- ๐Ÿ–ฅ๏ธ [systems](https:/github.com/isabelroses/dotfiles/tree/main//systems/)
- โ˜€๏ธ [Amaterasu](https:/github.com/isabelroses/dotfiles/tree/main//systems/amaterasu) My high-end gaming machine
- ๐Ÿ‰ [Hydra](https:/github.com/isabelroses/dotfiles/tree/main//systems/hydra/) A super mid spec laptop
- โšธ [Lilith](https:/github.com/isabelroses/dotfiles/tree/main//systems/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh
- โš–๏ธ [minerva](https:/github.com/isabelroses/dotfiles/tree/main//systems/minerva/) A server configuration for some of my infrastructure
- ๐–ค [Valkyrie](https:/github.com/isabelroses/dotfiles/tree/main//systems/valkyrie/) A WSL2 host, designed to be a development environment on Windows
- ๐Ÿ’ฎ [Tatsumaki](https:/github.com/isabelroses/dotfiles/tree/main//systems/tatsumaki/) A MacBook Air, configured to last a whole day of university
- ๐Ÿงฉ [parts](https:/github.com/isabelroses/dotfiles/tree/main//parts/) NixOS parts breaking down the complex configuration into smaller more manageable chunks
- ๐Ÿ“š [lib](https:/github.com/isabelroses/dotfiles/tree/main//parts/lib/) Useful repeated functions
- ๐Ÿ› ๏ธ [templates](https:/github.com/isabelroses/dotfiles/tree/main//parts/templates/) Templates for setting up development environments
- ๐Ÿ‘พ [modules](https:/github.com/isabelroses/dotfiles/tree/main//parts/modules/) Exported modules for NixOS, home-manager and Nix Darwin
- ๐Ÿ”Œ [modules](https:/github.com/isabelroses/dotfiles/tree/main//modules/)
- [base](https:/github.com/isabelroses/dotfiles/tree/main//modules/base/) The base configuration settings, which are common between all systems
- [darwin](https:/github.com/isabelroses/dotfiles/tree/main//modules/darwin/) Pre-made modules for exclusively darwin systems
- [nixos](https:/github.com/isabelroses/dotfiles/tree/main//modules/nixos/) Pre cooked modules for exclusively nixos systems
- [iso](https:/github.com/isabelroses/dotfiles/tree/main//modules/iso/) Pre-configured modules prepared for making NixOS iso images
- [extra](https:/github.com/isabelroses/dotfiles/tree/main//modules/extra) Extra configuration modules, for home-manager and Nix Darwin and NixOS
- [profiles](https:/github.com/isabelroses/dotfiles/tree/main//modules/profiles/) Pre-made profiles for different system types
- [hardware](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/hardware) Optimized settings for different devices (e.g., laptop, servers, desktop)
- [meta](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/meta) Optimized configurations for different natures (e.g., headless, graphical)
- ๐Ÿ“š [docs](https:/github.com/isabelroses/dotfiles/tree/main/docs/) The documentation for the dotfiles
- ๐Ÿ  [home](https:/github.com/isabelroses/dotfiles/tree/main/home/) Where all home-manager configurations lie
- ๐Ÿ–ฅ๏ธ [systems](https:/github.com/isabelroses/dotfiles/tree/main/systems/)
- โ˜€๏ธ [Amaterasu](https:/github.com/isabelroses/dotfiles/tree/main/systems/amaterasu/) My high-end gaming machine
- ๐Ÿก [Cottage](https:/github.com/isabelroses/dotfiles/tree/main/systems/cottage/) A Lowend laptop, its not great but it gets the job done
- ๐Ÿ‰ [Hydra](https:/github.com/isabelroses/dotfiles/tree/main/systems/hydra/) A super mid spec laptop
- โšธ [Lilith](https:/github.com/isabelroses/dotfiles/tree/main/systems/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh
- โš–๏ธ [minerva](https:/github.com/isabelroses/dotfiles/tree/main/systems/minerva/) A server configuration for some of my infrastructure
- ๐–ค [Valkyrie](https:/github.com/isabelroses/dotfiles/tree/main/systems/valkyrie/) A WSL2 host, designed to be a development environment on Windows
- ๐Ÿ’ฎ [Tatsumaki](https:/github.com/isabelroses/dotfiles/tree/main/systems/tatsumaki/) A MacBook Air, configured to last a whole day of university
- โœจ [wisp](https:/github.com/isabelroses/dotfiles/tree/main/systems/wisp/) A WSL2 host, on cottage
- ๐Ÿ”Œ [modules](https:/github.com/isabelroses/dotfiles/tree/main/modules/)
- [base](https:/github.com/isabelroses/dotfiles/tree/main/modules/base/) The base configuration settings, which are common between all systems
- [darwin](https:/github.com/isabelroses/dotfiles/tree/main/modules/darwin/) Pre-made modules for exclusively darwin systems
- [nixos](https:/github.com/isabelroses/dotfiles/tree/main/modules/nixos/) Pre cooked modules for exclusively nixos systems
- [iso](https:/github.com/isabelroses/dotfiles/tree/main/modules/iso/) Pre-configured modules prepared for making NixOS iso images
- [extra](https:/github.com/isabelroses/dotfiles/tree/main/modules/extra/) Extra configuration modules, for home-manager and Nix Darwin and NixOS
- [parts](https:/github.com/isabelroses/dotfiles/tree/main/modules/falake/) NixOS parts breaking down the complex configuration into smaller more manageable chunks
- ๐Ÿ“š [lib](https:/github.com/isabelroses/dotfiles/tree/main/modules/flake/lib/) Useful repeated functions
- ๐Ÿ› ๏ธ [templates](https:/github.com/isabelroses/dotfiles/tree/main/modules/flake/templates/) Templates for setting up development environments
- ๐Ÿ‘พ [modules](https:/github.com/isabelroses/dotfiles/tree/main/modules/flake/modules.nix) Exported modules for NixOS, home-manager and Nix Darwin
- ๐Ÿ“ฆ [packages](https:/github.com/isabelroses/dotfiles/tree/main/modules/flake/packages.nix) Packages that are not available in the official Nixpkgs
- [profiles](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/) Pre-made profiles for different system types
- [desktop](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/desktop/) A profile for desktop systems
- [graphical](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/graphical/) A profile for graphical systems
- [headless](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/headless/) A profile for headless systems
- [laptop](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/laptop/) A profile for laptop systems
- [server](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/server/) A profile for server systems
- [wsl](https:/github.com/isabelroses/dotfiles/tree/main/modules/profiles/wsl/) A profile for WSL2 systems

0 comments on commit e729820

Please sign in to comment.