Merge #404

404: docs: update structure r=roberth a=woile related #388 Co-authored-by: Santiago Fraire <[email protected]> Co-authored-by: Robert Hensing <[email protected]>
hercules-ci · Jul 3, 2023 · 7e1629c · 7e1629c
2 parents fab7c94 + f49b3cd
commit 7e1629c
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/site/_redirects b/site/_redirects
@@ -0,0 +1 @@
+/getting-things.html    /cheat-sheet.html
diff --git a/site/site-module.nix b/site/site-module.nix
@@ -60,6 +60,7 @@
           done
           mdbook build --dest-dir $TMPDIR/out
           cp -r $TMPDIR/out/html $out
+          cp _redirects $out
 
           echo '<html><head><script>window.location.pathname = window.location.pathname.replace(/options.html$/, "") + "options/flake-parts.html"</script></head><body><a href="options/flake-parts.html">to the options</a></body></html>' \
             >$out/options.html

diff --git a/site/src/SUMMARY.md b/site/src/SUMMARY.md
@@ -1,17 +1,18 @@
 # Summary
 
 - [Introduction](./README.md)
+- [Getting Started](./getting-started.md)
+- [Cheat Sheet](./cheat-sheet.md)
+- [Tutorials]()
+  - [Best Practices for Module Writing](./best-practices-for-module-writing.md)
+  - [Multi-platform: Working with `system`](./system.md)
 - [Guides]()
-  - [Getting Started](./getting-started.md)
   - [Explore and debug option values](./debug.md)
   - [Define a Module in a Separate File](./define-module-in-separate-file.md)
   - [Define Custom Flake Attribute](./define-custom-flake-attribute.md)
   - [Dogfood a Reusable Flake Module](./dogfood-a-reusable-module.md)
-- [Mixed Documentation]()
+- [Explanation]()
   - [Overlays](./overlays.md)
-  - [Best Practices for Module Writing](./best-practices-for-module-writing.md)
-  - [Working with `system`](./system.md)
-  - [Getting Things](./getting-things.md)
 - [Reference Documentation]()
   - [Module Arguments](./module-arguments.md)
   - [Options](./options/flake-parts.md)

diff --git a/site/src/getting-things.md → site/src/cheat-sheet.md b/site/src/getting-things.md → site/src/cheat-sheet.md
@@ -1,10 +1,10 @@
 
-# Getting Things
+# Cheat Sheet
 
 Flake-parts offers a couple of ways to access the same thing. This gives you
 freedom to pick the most convenient syntax for a use case.
 
-This page is like a cheat sheet, for you to get a feel for what's what.
+This page is for you to get a feel for what's what.
 
 ## Get a locally defined package
 

diff --git a/site/src/system.md b/site/src/system.md
@@ -1,5 +1,5 @@
 
-# `system`
+# Multi-platform: `system`
 
 In Nix, "system" generally refers to the cpu-os string, such as `"x86_64-linux"`.