diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7a6d1ff2a..cb7805dba 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -39,7 +39,7 @@ exclude_docs: | /drafts/ nav: - - index.md + - Home: index.md - Getting Started: - getting-started/index.md - Installer: getting-started/installer.md diff --git a/docs/site/blog/index.md b/docs/site/blog/index.md index c58f16c50..039e3cf7f 100644 --- a/docs/site/blog/index.md +++ b/docs/site/blog/index.md @@ -1,2 +1,2 @@ -# Blog +# :fontawesome-solid-blog: Blog diff --git a/docs/site/concepts/index.md b/docs/site/concepts/index.md index c6065e3d2..5303c9328 100644 --- a/docs/site/concepts/index.md +++ b/docs/site/concepts/index.md @@ -1,3 +1,3 @@ -# Core Concepts +# :simple-abstract: Concepts TODO diff --git a/docs/site/getting-started/configure.md b/docs/site/getting-started/configure.md index da41ccbdf..6eb06d1f0 100644 --- a/docs/site/getting-started/configure.md +++ b/docs/site/getting-started/configure.md @@ -126,7 +126,7 @@ Adding or configuring a new machine requires two simple steps: # IMPORTANT! Add your SSH key here # e.g. > cat ~/.ssh/id_ed25519.pub - users.users.root.openssh.authorizedKeys.keys = "__YOUR_SSH_KEY__"; + users.users.root.openssh.authorizedKeys.keys = [ "__YOUR_SSH_KEY__" ]; # ... } diff --git a/docs/site/getting-started/index.md b/docs/site/getting-started/index.md index 9766cb520..afe171317 100644 --- a/docs/site/getting-started/index.md +++ b/docs/site/getting-started/index.md @@ -1,4 +1,4 @@ -# Getting Started +# :material-clock-fast: Getting Started Create your own clan with these initial steps and manage a fleet of machines with one single testable git repository! diff --git a/docs/site/index.md b/docs/site/index.md index ed40c8b52..434c560d5 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -4,9 +4,7 @@ hide: - toc --- -# Home - -## Welcome to **Clan**'s documentation +# :material-home: Welcome to **Clan**'s awesome documentation [Getting Started](./getting-started/index.md){ .md-button } diff --git a/docs/site/manual/index.md b/docs/site/manual/index.md index 143807602..1b623b10a 100644 --- a/docs/site/manual/index.md +++ b/docs/site/manual/index.md @@ -1,4 +1,4 @@ -# :material-book: Manual +# :material-book: Guides Instructions and explanations for practical Implementations ordered by Topics. diff --git a/docs/site/reference/nix-api/buildclan.md b/docs/site/reference/nix-api/buildclan.md deleted file mode 100644 index 77ba9a66a..000000000 --- a/docs/site/reference/nix-api/buildclan.md +++ /dev/null @@ -1,170 +0,0 @@ -# BuildClan - -This provides an overview of the available arguments of the `buildClan` function. - -!!! Note "Flake-parts" - Each attribute is also available via `clan.