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

Docs: add top-level index, refactor according to diataxis

Browse Source
This commit is contained in:
Johannes Kirschbauer
2024-09-22 18:38:14 +02:00
parent 350ed0b1fe
commit 55526b1fdb
11 changed files with 207 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/site/reference/index.md
View File

@@ -1,6 +1,20 @@
This section of the site provides an automatically generated overview of the available options and commands within the Clan Framework.
# :material-api: Overview
This section of the site provides an **automatically extracted** overview of the available options and commands within the Clan Framework.
---
- Learn how to use the [Clan CLI](./cli/index.md)
- Explore available services and application [modules](./clanModules/index.md)
- Discover [configuration options](./clan-core/index.md) that manage essential features
- Find descriptions of the [Nix interfaces](./nix-api/index.md) for defining a Clan
- Find descriptions of the [Nix interfaces](./nix-api/index.md) for defining a Clan
---
!!! Note
This documentation is always built for the main branch.
If you need documentation for a specific commit you can build it on your own
```bash
nix build 'git+https://git.clan.lol/clan/clan-core?ref=0324f4d4b87d932163f351e53b23b0b17f2b5e15#docs'
```