Orchestrate gitbuilding

.github/workflows/publish.yml

@@ -45,6 +45,10 @@ jobs:
         run: |
           ./generate_static.py
 
+      - name: Generate example docs
+        run: |
+          ./generate.py
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:

.gitignore

@@ -1,6 +1,8 @@
 
 _site/
+_gb_temp_/
 build/
+
 .vscode/*
 .venv/
 __pycache__/

documentation/PeliCalse1430.md

@@ -0,0 +1,20 @@
+---
+PartData:
+    Specs:
+        Internal Dimensions: 360 x 162 x 295 mm
+        Internal Lid Depth: 50 mm
+        Internal Base Depth: 245 mm
+        External Dimensions: 430 x 244 x 341 mm
+        Weight Empty: 2.54 kg
+        Weight With Foam: 2.95 kg
+        IP rating: IP67
+        Airline carry on size?: True
+    Suppliers:
+        Peli Products:
+            PartNo: 1430-001-110
+            Link: https://peliproducts.co.uk/products/1430-protector-case
+---
+
+# Peli Case 1430
+
+To print the nimble you will need a fused filament fabrication (FFF) 3D printer, sometimes called a FDM printer. Most FDM printers should do.

documentation/README.md

@@ -1,30 +1,5 @@
-<!--
-SPDX-FileCopyrightText: 2023 Andreas Kahler <mail@andreaskahler.com>
+# Nimble example docs
 
-SPDX-License-Identifier: CERN-OHL-S-2.0
--->
+This directory contains fixed documentation for all nimble racks and the templates that will be used by our orchestration script to generate complete documentation for any custom rack.
 
-# This project is documented with GitBuilding
-
-## What is GitBuilding
-
-GitBuilding is an OpenSource project for documenting hardware projects with minimal
-effort, so you can stop writing and GitBuilding. GitBuilding is a python program that
-works on Windows, Linux, and MacOS. More information on the GitBuilding project, or how
-to install GitBuilding please see the [GitBuilding website](http://gitbuilding.io)
-
-## How do I edit the documentation?
-
-To edit the documentation you do not need to install anything, but you will need to
-install something to build the final version of the documentation (such as a website).
-The documentation files can be opened in a plain text editor such as Windows Notepad,
-Notepad++, gedit, VS Code, etc. GitBuilding also comes with a browser-based editor that
-displays has a live display of the final HTML documentation.
-
-If you have ever used [markdown](https://www.markdownguide.org/basic-syntax/) you will
-notice that the files you are editing are markdown files. GitBuilding uses an extended
-markdown syntax (that we call BuildUp). This allows you to keep track of parts in the
-documentation. More detail on the documentation is available on the
-[GitBuilding website](https://gitbuilding.io/syntax/). There is also additional
-[syntax for configuration](https://gitbuilding.io/syntax/buildconfsyntax), and for
-[part libraries](https://gitbuilding.io/syntax/builduplibrary/).
+As these scripts are not yet complete please see our [example documentation repository](https://github.com/Wakoma/nimble-example-documentation).

documentation/_templates/header.html.jinja

@@ -0,0 +1,15 @@
+<div class=header-text>
+{% if title is not none %}
+    <a class="wakoma-logo-link" href="https://wakoma.co/nimble//"><img class="wakoma-logo" src="{{root}}assets/wakoma-logo.png"></a>
+    <h1 class="site-title">{{title}}</h1>
+{%endif %}
+{% if subtitle is not none %}
+    <p class="site-subtitle">{{subtitle}}</p>
+{%endif %}
+{% if authors is not none %}   
+    <p class="author">by {{authors}}</p>
+{%endif %}
+{% if affiliation is not none %}
+    <p class="affiliation">{{affiliation}}</p>
+{%endif %}
+</div>

documentation/assets/style.css

@@ -0,0 +1,19 @@
+
+
+.wakoma-logo{
+    width:60%;
+}
+
+.wakoma-logo-link{
+  line-height: 0.5;
+}
+
+.site-title {
+	color: #424242;
+	font-size: 32px;
+	font-weight: 400;
+	line-height: 54px;
+	letter-spacing: -1px;
+	margin-bottom: 0;
+	display: flex;
+}

documentation/buildconf.yaml

@@ -1,31 +1,32 @@
-
-Title: 'Nimble Rack'
-
-Authors:
-    - The Nimble team
-
-Affiliation: Wakoma
-
+AutoCompleteSubNav: true
+CustomCategories:
+  consumable:
+    DisplayName: Comsumables
+    Reuse: false
+  mech:
+    DisplayName: Mechanical Components
+    Reuse: false
+  net:
+    DisplayName: Networking Compontents
+    Reuse: false
+  prev:
+    DisplayName: Previously Assembled
+    Reuse: false
+  printed:
+    DisplayName: 3D printed parts
+    Reuse: false
+DefaultCategory: mech
+HoverColor: '#555555'
 License: CERN-OHL-S-2.0
-
-Email: info@wakoma.co
-
-
-#Uncomment below to add custom categories
-#CustomCategories:
-#    printedtool:
-#        Reuse: False
-#        DisplayName: Printed tools
-
-#Uncomment below to set a custom default category
-#DefaultCategory: printedtool
-
-#Uncomment below to set the title for the bill of material on a page
-#PageBOMTitle: '##For this step you will need'
-
-
-#Uncomment below to set a custom Website root for static HTML builds
-# WebsiteRoot: index.html
-
-#Uncomment below to disable fussy warnings
-#Fussy: False
+Navigation:
+  - Link: config.md
+    Title: Your Nimble Configuration
+  - Link: troubleshooting.md
+    Title: Troubleshooting
+  - Link: knowledgebase.md
+    Title: Knowledge Base
+PageBOMTitle: '## For this page you will need'
+PrimaryColor: '#2d3b46'
+SecondaryColor: '#cccccc'
+ExternalDirs:
+  project: ".."

documentation/case.md

@@ -0,0 +1,38 @@
+---
+Make:
+  AP Mount Top:
+    template: printing.md
+    stl-file: ../Legacy/STLs/ap_mount_for_1430_top.stl
+    stlname: ap_mount_for_1430_top.stl
+    material: PLA
+    weight-qty: 40g
+    supports: "Yes"
+  AP Mount Bottom:
+    template: printing.md
+    stl-file: ../Legacy/STLs/ap_mount_for_1430_bottom.stl
+    stlname: ap_mount_for_1430_bottom.stl
+    material: PLA
+    weight-qty: 40g
+    supports: "Yes"
+---
+
+# Prepare the case
+
+{{BOM}}
+
+[M4x10mm countersunk screws]: parts/Hardware.yaml#CskScrew_M4x10mm_SS
+[M4x10mm cap screws]: parts/Hardware.yaml#CapScrew_M4x10mm_SS
+
+## Construct the lid insert {pagestep}
+
+* Join [AP Mount Top]{make, qty:1,cat:printed} and [AP Mount Bottom]{make, qty:1,cat:printed} together using two [M4x10mm countersunk screws]{qty: 2,cat: mech} and a [3mm Allen key](parts/metric_allen_keys.md){qty: 1,cat: tool}
+* Using three more [M4x10mm countersunk screws]{qty: 3,cat: mech} attach the brackets that came with your three UniFi Access Points to the holes just below the join between the two prints.
+
+## Attach to case{pagestep}
+
+* Get your [Peli Case][Peli Case 1430](PeliCalse1430.md){qty:1} and open the lid.
+* Locate the mounting lugs on the Peli Case lid and align the lid insert with these lugs
+* Use [M4x10mm cap screws]{qty: 2,cat: mech} to attach the inset into the Peli Case.
+
+>!! **TODO**  
+>!! Add images of this step

documentation/config.md

@@ -0,0 +1,11 @@
+#  Your Nimble Configuration
+
+The nimble is a modular rack-and-shelf system. The first part of construction is to 3D print the custom parts, and then to assemble the shelves.
+
+The shelves in your system are:
+
+{{listpages, tag:shelf}}
+
+Once you have assembled each shelf, you will [construct the rack](construction.md){step} and [prepare the case](case.md){step} before finally [wiring up the system](wiring.md){step} and [setting it up](setup.md){step}.
+
+Make sure you have [all the parts you need]{bom}, before you start assembly.

documentation/construction.md

@@ -0,0 +1,66 @@
+---
+Make:
+  base plate:
+    template: printing.md
+    stl-file: ../build/printed_components/baseplate.stl
+    stlname: baseplate.stl
+    material: PLA
+    weight-qty: 50g
+  top plate:
+    template: printing.md
+    stl-file: ../build/printed_components/topplate.stl
+    stlname: topplate.stl
+    material: PLA
+    weight-qty: 50g
+  rack legs:
+    template: printing.md
+    stl-file: ../build/printed_components/beam.stl
+    stlname: beam.stl
+    material: PLA
+    weight-qty: 60g
+  stuff shelf:
+    template: printing.md
+    stl-file: models/Stuff_Shelf_1.0.stl
+    stlname: Stuff_Shelf_1.0.stl
+    material: PLA
+    weight-qty: 50g
+---
+
+# Construct and populate the rack
+
+{{BOM}}
+
+[M4x10mm countersunk screws]: parts/Hardware.yaml#CskScrew_M4x10mm_SS
+[M4x10mm cap screws]: parts/Hardware.yaml#CapScrew_M4x10mm_SS
+
+## Attach the legs to the base plate {pagestep}
+
+* Get the [base plate]{make, qty:1, cat:printed} and the four [rack legs]{make, qty:4, cat:printed} that you printed earlier.
+* Get a [3mm Allen key](parts/metric_allen_keys.md){qty:1, cat:tool} ready
+* Use four [M4x10mm countersunk screws]{qty:4} to attach a leg to each corner of the bottom.
+
+>!! **TODO**  
+>!! Add images of this step
+
+## Add the broad shelves {pagestep}
+
+>!! **TODO**  
+>!! Each shelf that is broad should be added in this stage
+
+
+## Mount the top plate {pagestep}
+
+* Take the [top plate]{make, qty:1, cat:printed} and place it on top of the rack.
+* Use four [M4x10mm countersunk screws]{qty:4} to attach the shelf to the four legs of the rack
+
+>!! **TODO**  
+>!! Add images of this step
+
+
+## Insert the remaining shelves {pagestep}
+
+>!! **TODO**  
+>!! Explain what order the assembled shelves are used.
+
+
+