# Documentation

> Manual on how to use this repo.

---

LLMS index: [llms.txt](/llms.txt)

---

# Welcome

Welcome to the docs for the
[nix-configuration](https://git.jan-leila.com/jan-leila/nix-config).

This is the top level index and directory for you to use to look for information
on how to do things.

The target audience of this documentation is both as an introduction to new
users as well as record keeping about the design patterns employed for reference
at a later date by power users.

The intended ways to consume this documentation are the following:

- as a website hosted at https://nix-config-docs.jan-leila.com
- as markdown text colocated in the repository with the configuration

# Directory

- **[Administration](administration/README.md)** - how to deploy and update
  configurations
- **[Contributing](contributing/README.md)** - how to change the configs to
  better work for you and how to organize your updates
- **[Hosts](hosts/README.md)** - configurations that are produced as a part of
  this repository
- **[Modules](modules/README.md)** - how to configure all of the different
  modules
- **[Design](design/README.md)** - the philosophies used in the design of
  modules to produce maintainable software
- **[Automations](automations/README.md)** - the reasoning behind each of the
  automations that help maintain this repo

---

Section pages:

- [Administration](/administration/): How to use the systems that already exist, and how to rotate or replace things on them as needed.
- [Contributing](/contributing/): How to set up new things in this repository and what tooling you will run into while doing it.
- [Hosts](/hosts/): The machines in the fleet, and what each of them is for.
- [Modules](/modules/): How to configure different types of modules.
- [Design](/design/): The design philosophies underpinning the work here.
- [Automations](/automations/): The reasoning behind the choices driving each individual automation that helps maintain this repo.