srvos/mkdocs.yml
zimbatm 48ac318b05
docs: refactor
This commit does a lot of things at ones:

* introduce a temporary logo to unbreak the image reference in the docs
* introduce a getting started documentation
* introduce a proper user guide. It's still missing a lot of things.
* rename the various categories of modules to be clearer.
* complete the missing module references.
* add a tiny FAQ
2023-04-14 16:04:43 +02:00

30 lines
757 B
YAML

INHERIT: !ENV MKDOCS_NUMTIDE_THEME
### Site metadata ###
site_name: SrvOS
site_description: NixOS profiles for servers
site_url: https://numtide.github.io/srvos/
repo_name: 'numtide/srvos'
repo_url: https://github.com/numtide/srvos
edit_uri: edit/main/docs
### Navigation ###
nav:
- Home: index.md
- Getting started: getting_started.md
- User guide:
- Intro: user_guide.md
- NixOS modules:
- Machine type: nixos/type.md
- Machine hardware: nixos/hardware.md
- Machine role: nixos/role.md
- Configuration mixins: nixos/mixins.md
- Roles:
- GitHub Action Runner: github_actions_runner.md
- Installation:
- Hetzner Cloud: installation/hetzner_cloud.md
- FAQ: faq.md
- Getting help: help.md