docs: Fix documentation navigation and flakes tutorial

- Fix typo in URL (startet -> started)
- Change casing in heading (Started -> started)
- Add redirect for old typo filename to avoid broken links
- Improve flakes tutorial slightly with example and references

Author: sshine

book.toml

@@ -23,6 +23,7 @@ enable = false
 follow-web-links = false
 
 [output.html.redirect]
+# Redirecting because of brokenness when using subdirectories
 "documentation/flakes.html" = "../flakes.html"
 "documentation/functions.html" = "../functions.html"
 "documentation/getting-started.html" = "../getting-started.html"
@@ -43,3 +44,6 @@ follow-web-links = false
 "news/2023-09-22_release-2.7.0.html" = "../news-2023-09-22_release-2.7.0.html"
 "news/2024-10-15_release-2.8.0.html" = "../news-2024-10-15_release-2.8.0.html"
 "news/2025-11-09_website_renewal.html" = "../news-2025-11-09_website_renewal.html"
+
+# Redirecting because of typos and restructuring
+"getting-startet-with-nix-flakes.html" = "getting-started-with-flakes.html"

src/SUMMARY.md

@@ -3,10 +3,10 @@
 # Documentation
 
 - [Introduction](index.md)
-- [Getting Started](getting-started.md)
+- [Getting started](getting-started.md)
   - [What is Terraform / OpenTofu?](what-is-terranix.md)
-  - [Getting Started with nix flake](getting-startet-with-nix-flakes.md)
-- [Differences between terranix and HCL](terranix-vs-hcl.md)
+  - [Getting started with flakes](getting-started-with-flakes.md)
+  - [Differences between terranix and HCL](terranix-vs-hcl.md)
 - [Functions](functions.md)
 - [Modules](modules.md)
 - [terranix via nix flakes](flakes.md)

src/getting-startet-with-nix-flakes.md src/getting-started-with-flakes.mdsrc/getting-startet-with-nix-flakes.md renamed to src/getting-started-with-flakes.md

@@ -1,16 +1,22 @@
-[nix flakes](https://nixos.wiki/wiki/Flakes)
+# Getting started with flakes
+
+[Nix flakes](https://nixos.wiki/wiki/Flakes)
 make dependency management of modules and packages much easier.
 
 Deeper look at terranix and nix flakes is done in the
-[flake chapter](flakes.md)
+[flake chapter](flakes.md).
 
-## nix build
+## A minimal flake.nix
 
-Here is a minimal `flake.nix`
+Extending [Getting started](./getting-started.md), this minimal flake your terranix resources are defined in `config.nix`:
 
 ```nix
 {
-  inputs.terranix.url = "github:terranix/terranix";
+  inputs = {
+    terranix.url = "github:terranix/terranix";
+    terranix.inputs.nixpkgs.follows = "nixpkgs";
+  };
+
   outputs = { terranix, ... }:
     let
       system = "x86_64-linux";
@@ -24,18 +30,34 @@ Here is a minimal `flake.nix`
 }
 ```
 
-You can run `nix build -o config.tf.json`, which should create a `config.tf.json`
-in your current folder.
-Now you are ready to run `terraform`.
+## nix build
+
+Instead of `terranix config.nix > config.tf.json`, you can run `nix build -o config.tf.json`:
+
+```
+nix build -o config.tf.json
+tofu init
+tofu apply
+```
+
+Use terraform or tofu if you installed either of them plainly.
 
 ## nix run
 
-Of course, you can use `apps` to do everything at once.
+You can create Nix flake _apps_ that let you run:
+
+- `nix run`
+- `nix run .#apply`
+- `nix run .#destroy`
 
 ```nix
 {
-  inputs.nixpkgs.url = "github:nixos/nixpkgs";
-  inputs.terranix.url = "github:terranix/terranix";
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs";
+    terranix.url = "github:terranix/terranix";
+    terranix.inputs.nixpkgs.follows = "nixpkgs";
+  };
+
   outputs = { self, nixpkgs, terranix, ... }:
     let
       system = "x86_64-linux";
@@ -58,6 +80,7 @@ Of course, you can use `apps` to do everything at once.
               && ${terraform}/bin/terraform apply
           '');
         };
+
         # nix run ".#destroy"
         destroy = {
           type = "app";
@@ -69,10 +92,9 @@ Of course, you can use `apps` to do everything at once.
           '');
         };
       };
+
       # nix run
       defaultApp.${system} = self.apps.${system}.apply;
     };
 }
 ```
-
-This provides you with the commands `nix run`, `nix run ".#apply"` and `nix run ".#destroy"`.

src/getting-started.md

@@ -1,4 +1,4 @@
-# Getting Started
+# Getting started
 
 Let's have a quick overview on how you could use terranix.