Create Writeups Section in preparation for further docs

royalgraphx · Jun 27, 2023 · 7815b3c · 7815b3c
1 parent 09b5c5c
commit 7815b3c
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 0 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -24,6 +24,33 @@ callouts:
     title: Warning
     color: reddish
 
+# set up collections
+
+# Define Jekyll collections
+collections:
+  # Define a collection named "writeups", its documents reside in the "_writeups" directory
+  writeups:
+    permalink: "/:collection/:path/"
+    output: true
+
+just_the_docs:
+  # Define which collections are used in just-the-docs
+  collections:
+    # Reference the "tests" collection
+    writeups:
+      # Give the collection a name
+      name: Writeups
+      # Exclude the collection from the navigation
+      # Supports true or false (default)
+      nav_exclude: false
+      # Fold the collection in the navigation
+      # Supports true or false (default)
+      nav_fold: false  # note: this option is new in v0.4
+      # Exclude the collection from the search
+      # Supports true or false (default)
+      search_exclude: false
+
+# Set up includes
 include:
  - docs
  - _sass

diff --git a/docs/_writeups/01-USB-Mapping/01-Prerequisites.md b/docs/_writeups/01-USB-Mapping/01-Prerequisites.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: Part 0 - Prerequisites
+parent: USB Mapping
+nav_order: 1
+---
+
+# Prerequisites
+#### Placeholder caption
+
diff --git a/docs/_writeups/01-USB-Mapping/index.md b/docs/_writeups/01-USB-Mapping/index.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: USB Mapping
+nav_order: 1
+has_children: true
+---
+
+<p align="center">
+  <img width="650" height="200" src="../../../assets/HeaderUSBMapping.png">
+</p>
diff --git a/docs/_writeups/02-Custom-Memory-Mapping/01-Prerequisites.md b/docs/_writeups/02-Custom-Memory-Mapping/01-Prerequisites.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: Part 0 - Prerequisites
+parent: Custom Memory Mapping
+nav_order: 1
+---
+
+# Prerequisites
+#### Placeholder caption
+
diff --git a/docs/_writeups/02-Custom-Memory-Mapping/index.md b/docs/_writeups/02-Custom-Memory-Mapping/index.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: Custom Memory Mapping
+nav_order: 2
+has_children: true
+---
+
+<p align="center">
+  <img width="650" height="200" src="../../../assets/HeaderCMM.png">
+</p>
diff --git a/docs/_writeups/03-DisplayOverrides/01-Prerequisites.md b/docs/_writeups/03-DisplayOverrides/01-Prerequisites.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: Part 0 - Prerequisites
+parent: Display Overrides
+nav_order: 1
+---
+
+# Prerequisites
+#### Placeholder caption
+
diff --git a/docs/_writeups/03-DisplayOverrides/index.md b/docs/_writeups/03-DisplayOverrides/index.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: Display Overrides
+nav_order: 3
+has_children: true
+---
+
+<p align="center">
+  <img width="650" height="200" src="../../../assets/HeaderDisplayOverridesTextOnly.png">
+</p>
diff --git a/docs/assets/HeaderCMM.png b/docs/assets/HeaderCMM.png
diff --git a/docs/assets/HeaderDisplayOverridesTextOnly.png b/docs/assets/HeaderDisplayOverridesTextOnly.png
diff --git a/docs/assets/HeaderUSBMapping.png b/docs/assets/HeaderUSBMapping.png