yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add reference index pages

Browse Source 
- add index pages for each reference documentation category
- move concepts pages into the reference hierarchy
- render clanModules overview page in the style of the CLI overview
This commit is contained in:
Valentin Gagarin
2024-07-12 19:02:19 -04:00
committed by Johannes Kirschbauer
parent 27b4b1ed00
commit b3fd59a802
10 changed files with 182 additions and 267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/site/reference/nix-api/index.md Normal file
View File

@@ -0,0 +1,6 @@
# Nix API Overview
There are two top-level components of the Nix API, which together allow for the declarative definition of a Clan:
- the [Inventory](./inventory.md), a structure representing the machines, services, custom configurations, and other data that constitute a Clan, and
- the [`buildClan`](./buildclan.md) function, which constructs a Clan from an Inventory definition.