Overhaul documentation

assets/scss/_styles_project.scss

@@ -2,6 +2,16 @@ body {
   line-height: 1.7em;
 }
 
+.td-navbar .navbar-brand svg {
+  transform: scale(1.5);
+  margin-right: 1.5rem;
+}
+
+.td-navbar .navbar-brand .text-uppercase {
+  text-transform: none !important;
+  // font-weight: normal !important;
+}
+
 .td-content {
   max-width: 60rem;
 }
@@ -102,15 +112,28 @@ body {
   }
 
   .td-content {
-    column-count: 2;
-    column-gap: 2rem;
-
-    > h1, > h2, > h3, > p, > ul, > .alert, > blockquote {
+    > h1,
+    > h2,
+    > h3,
+    > p,
+    > ul,
+    > ol,
+    > .alert,
+    > .highlight,
+    > .lead,
+    > dl dd,
+    > pre,
+    .footnotes,
+    > blockquote {
       column-span: all;
+      max-width: 100%;
     }
 
     figure {
       break-inside: avoid;
+      max-width: 50%;
+      float: left;
+      padding: 0.5em;
     }
   }
 }

config.toml

@@ -141,7 +141,7 @@ breadcrumb_disable = false
 #  Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
 sidebar_search_disable = false
 #  Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
-navbar_logo = false
+navbar_logo = true
 # Set to true to disable the About link in the site footer
 footer_about_disable = false
 

content/_index.de.html

@@ -37,7 +37,7 @@ <h1>Überholabstandsmessung für Radfahrende.</h1>
 Komm in unseren offenen Slack. Tausche Dich aus. Stelle Fragen. Finde Leute aus Deiner Region. Hier koordinieren wir uns, stimmen uns ab und treffen gemeinschaftlich Entscheidungen.
 {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fas fa-biking" title="Bauen & Daten sammeln" url="/docs/hardware/v00.03/build-instructions/" url_text="Zur Bauanleitung" %}}
+{{% blocks/feature icon="fas fa-biking" title="Bauen & Daten sammeln" url="/docs/hardware/v00.03.12/build-instructions/" url_text="Zur Bauanleitung" %}}
 Bau Dir Deinen eigenen Überholabstandsmesser. Wir unterstützen Dich dabei. Am besten schließt Du Dich einer der Sammelbestellungen und einem unserer Regio-Teams an.
 {{% /blocks/feature %}}
 
@@ -72,7 +72,7 @@ <h2>Teil der Lösung</h2>
 
 Zentrales Hilfsmittel und Namensgeber des OpenBikeSensors ist unser Überholabstandsmesser,  ein kleines technisches Gerät am Fahrrad. Während der Fahrt misst es den Abstand nach links und rechts (minus Lenkerbreite) und zeichnet die Fahrt via GPS auf. Überholmanöver kann die:der Radler:in per Taste am Lenker bestätigen. Nicht aufgezeichnet werden Fahrzeug- oder Personendaten der Überholenden. Uns geht es hauptsächlich um die Seitenabstände zu anderen Verkehrsteilnehmer:innen.
 
-Wir wünschen uns, dass unser Sensor von vielen genutzt und weiterentwickelt wird. Die <a href="{{< relref "/docs/hardware/v00.03/build-instructions">}}">Anleitung zum Selberbauen und Montieren</a> ist für alle als Open Source verfügbar – hier auf unserer Website und <a href="https://github.com/openbikesensor" target="_blank" rel="noopener noreferrer nofollow">quelloffen via Github</a>. Wir entwickeln für die offenen Daten zudem <a href="{{< relref "#visualisierung">}}">Visualisierungskonzepte</a> (inklusive Visualisierungssoftware) und werten die Ergebnisse gemeinsam mit Forschungspartner:innen aus.
+Wir wünschen uns, dass unser Sensor von vielen genutzt und weiterentwickelt wird. Die <a href="{{< relref "/docs/hardware/v00.03.12/build-instructions">}}">Anleitung zum Selberbauen und Montieren</a> ist für alle als Open Source verfügbar – hier auf unserer Website und <a href="https://github.com/openbikesensor" target="_blank" rel="noopener noreferrer nofollow">quelloffen via Github</a>. Wir entwickeln für die offenen Daten zudem <a href="{{< relref "#visualisierung">}}">Visualisierungskonzepte</a> (inklusive Visualisierungssoftware) und werten die Ergebnisse gemeinsam mit Forschungspartner:innen aus.
 
 Uns geht es jedoch nicht nur um die Technik. Ergänzend entwickeln wir gemeinsam mit zivilgesellschaftlichen Organisationen und Kommunen regionale Aktionen, Kampagnen und Verkehrskonzepte. Wir gestalten Gesellschaft und leisten so einen Beitrag für mehr Lebensqualität in den Städten und auf dem Land.
 

content/docs/hardware/_index.de.md

@@ -3,6 +3,44 @@ title: Hardware
 weight: 40
 ---
 
-Diese Seite gibt es noch nicht in der aktuellen Sprache, aber auf...
+Dieser Bereich der Dokumentation beschreibt die möglichen Konfigurationen,
+anhand dener ein OpenBikeSensor Abstandsmessgerät gebaut werden kannst. Wir
+haben hier Bestelllisten für die Komponenten, und Anleitungen wie diese
+zusammenzufügen sind.
+
+Am Anfang solltest du dir klar werden, [welche Variante]({{< relref
+"general/models" >}}) du bauen möchtest. Hiervon hängt ab, welche Teile du
+benötigst. Die "Standard-Variante" ist immer in der Anleitung zur aktuellsten
+Version beschrieben.
+
+Die Bauteileliste enthält viele elektronische Komponenten, aber auch
+mechanische Bauteile und natürlich ein Gehäuse, sowie Kleinkram, z.B. Kabel und
+Befestigungen.
+
+Das Gehäuse wird im 3D-Druck-Verfahren hergestellt. Anweisungen und Anleitungen
+gibt es im [entsprechenden Abschnitt]({{< relref "general/case" >}}). Außerdem
+musst du eine [Platine erwerben]({{< relref "general/pcb" >}}), was in der
+Regeln durch Bestellung bei einem Hersteller anhand der Designdateien passiert.
+
+**Hinweis:** Diese Website ist noch (und auf absehbare Zeit) in Arbeit, einige
+Teile könnten unvollständig sein oder komplett fehlen. Auch Fehler sind nie
+auszuschließen.  Wenn du Schwierigkeiten hast, frag auf jeden Fall im Slack
+nach. Erwarte nicht, dass alles auf Anhieb klappt, aber es gibt genug Leute die
+dir gern weiterhelfen, und ihr Wissen teilen. Aber du brauchst auch keine Angst
+zu haben, loszulegen -- selbst wenn nicht immer offensichtlich ist, wie alles
+funktioniert, so ist es trotzdem auch für Anfänger:innen möglich, erfolgreich
+einen Sensor anhand dieser Anleitungen zu bauen.
+
+## Bausätze
+
+Weil ein Gerät aus so vielen Einzelteilen aus verschiedenen Quellen besteht,
+sind Sammelbestellungen eine gute Möglichkeit die Komplexität aufzuteilen und
+für jede:n Einzelne:n zu verringern. Dabei sparen wir alle Geld, denn in Menge
+bestellt sind viele Teile günstiger. Wenn du dich mit einer Lokalgruppe oder
+überregional vernetzen möchtest, um so einn Sammelbestellung durchzuführen oder
+daran teilzunehmen, komm in unseren Slack!
+
+{{< imgproc construction-kit Resize 600x >}}
+OpenBikeSensor 00.03.10 Bausatz
+{{< /imgproc >}}
 
-{{< language-switch >}}

content/docs/hardware/_index.en.md

@@ -7,13 +7,13 @@ This section documents the possible sensor configurations you can build for
 yourself, and also provides instructions what you need to purchase and how you
 are able to build your own OBS.
 
-Starting out, make sure to check out the [model selection]({{< relref "models" >}}) to figure
+Starting out, make sure to check out the [model selection]({{< relref "general/models" >}}) to figure
 out which version of the OBS you want to build.
 
-Next up, you will need to figure out all the [parts]({{< relref "parts" >}}) that you need to
-purchase or create. This includes a lot of electronic components, a PCB, the 3D
-printed case and fixtures, wires and fasteners. Check out the detailed BOM for
-your version.
+Next up, you will need to figure out all the parts that you need to purchase or
+create for your selected model. This includes a lot of electronic components, a
+PCB, the 3D printed case and fixtures, wires and fasteners. Check out the
+detailed BOM for your version.
 
 We also provide instructions here on printing your own cases, ordering PCBs
 from your favorite manufacturer, and for assembly of the sensor from all the
@@ -23,7 +23,7 @@ parts.
 documentation are not complete. If you run into trouble, ask in Slack. Don't
 expect a smooth experience just yet -- but we're working on it. However, don't
 fear, while not necessarily straightforward at all times, it is still very much
-possible for beginners to complete this build and construct their own OBS. 
+possible for beginners to complete this build and construct their own OBS.
 
 ## Construction kits
 

content/docs/hardware/general/_index.de.md

@@ -0,0 +1,5 @@
+---
+title: Allgemeines
+weight: 20
+---
+

content/docs/hardware/general/case/_index.de.md

@@ -0,0 +1,16 @@
+---
+title: Gehäusedruck
+weight: 30
+---
+
+{{< imgproc case Resize 600x >}}
+OpenBikeSensor-Bausatz der Version 00.03.10, mit einem "Vertical Case"
+{{< /imgproc >}}
+
+TODO:
+
+* Wie komme ich an ein Gehäuse?
+* Welche Dateien muss ich drucken?
+* Material, Farben
+* Druckeinstellungen
+

content/docs/hardware/case/_index.de.md → content/docs/hardware/general/case/_index.en.md

@@ -1,5 +1,5 @@
 ---
-title: Gehäusedruck
+title: Printing a case
 weight: 30
 ---
 

content/docs/hardware/parts/collective-order/_index.de.md → content/docs/hardware/general/collective-order/_index.de.md

@@ -1,12 +1,20 @@
 ---
-title: Sammelbestellungen
+title: Hinweise für Sammelbestellungen
+linkTitle: Sammelbestellungen
 weight: 10
 ---
 
+{{% alert title="Du möchtest an einer Sammelbestellung teilnehmen?" color="info" %}}
+Diese Dokumentationsseite beschreibt Hinweise für Menschen, die eine
+Sammelbestellung _organisieren_. Wenn du an der Organisation aktueller
+Sammelbestellungen interessiert bist, und zum Beispiel einen Bausatz auf diese
+Weise erhalten möchtest, besuch den Kanal `#obs_hw_bauteil-börse` im Slack.
+{{% /alert %}}
+
+
 Diese Seite soll einige Informationen bereitstellen, die wir bei früheren
 Sammelbestellungen gesammelt haben.
 
-
 ## Überprüfe alles noch einmal
 
 Bitte beachte, dass sich das Projekt noch in der Entwicklung befindet, d.h.
@@ -43,7 +51,7 @@ AJ-SR04M: das Modell von der Sammelbestellung im February 2021
 
 * Eigenschaften:
   * vermutlich kein Widerstand um den Betriebsmodus zu ändern
-  * quer liegender IC an der Anschlussseite 
+  * quer liegender IC an der Anschlussseite
   * 11.0592 MHz Schwingquarz
   * Betriebsspannung: 5V
 * Das Datenblatt, das oft auf Chinesischen Seiten erwähnt wird ist `JSN-SR04T一体化超声波测距说明书.pdf` ([Englische Übersetzung](jsn-sr04t-en.pdf)).

content/docs/hardware/general/models/_index.de.md

@@ -0,0 +1,20 @@
+---
+title: Modellauswahl
+weight: 10
+---
+
+Wenn du einen OpenBikeSensor Abstandsmesser bauen möchtest, musst du zunächst
+ein Modell, eine Version und eine Gehäusevariante auswählen.
+
+Aufgrund der Vielfalt in dem Projekt und der unterschiedlichen Anforderungen
+der Beteiligten gibt es auch eine Vielzahl Varianten für jedes Teil. Der
+Einfachheit halber pflegen wir jedoch hier auf der Website, in den Anleitungen
+und Bestelllisten, eine "Standard-Variante". Diese ist zur Zeit:
+
+* PCB Version 00.03.12
+* Hauptgehäuse "Vertical Case"
+* Displaygehäuse "SlideOnDisplay"
+
+Weitere mögliche Kombinationen werden wir irgendwann hier beschreiben, und die
+jeweiligen Bestandteile auch verlinken. Jetzt wollen wir uns zunächst darauf
+konzentrieren, diese "Standard-Variante" ausführlich zu dokumentieren.

content/docs/hardware/general/models/_index.en.md

@@ -0,0 +1,6 @@
+---
+title: Model selection
+weight: 10
+---
+
+{{< language-switch 1 >}}

content/docs/hardware/general/pcb/_index.de.md

@@ -0,0 +1,41 @@
+---
+title: Platine
+weight: 20
+---
+
+Ein sehr wichtiger Bestandteil des Gerätes ist die Platine, auch
+„PCB” (englisch _printed circuit board_) genannt. Der schwierige
+Teil hieran ist das „printed” -- ein PCB ist ein professionell
+hergestelltes Bauteil das schwierig selbst zu erstellen ist. Hier sind deine
+Optionen:
+
+* Das PCB anhand der Designdateien von einem Platinenhersteller anfertigen
+  lassen. Je nachdem wo, in welcher Qualität und wie viele Platinen du
+  bestellst wird dies erstaunlich wenig bis sehr viel kosten.
+* Finde heraus, ob jemensch anders schon Platinen anhand der gleichen Dateien hat herstellen lassen. Eventuell hat er:sie noch
+  Exemplare übrig, frag am besten im [Slack]({{< ref "slack" >}}) nach dafür.
+* Bastel dir selbst eine Platine, ganz im DIY-Stil. Da unseren Platinen jedoch
+  Durchkontaktierungen und beidseitige Leiterbahnen benötigen, ist das
+  besonders schwierig. Je nach Ausrüstung und Erfahrung ist es aber machbar.
+  Besonders viel günstiger als bestellen ist es allerdings vermutlich nicht.
+* Benutze keine Platine. Du kannst einen kompatiblen Sensor ganz ohne Platine
+  zusammenbauen, indem du die Komponenten mit Kabeln aneinander lötests.
+  Allerdings haben wir hierfür keine Anleitung und das Gehäuse wird auch nicht
+  passen. Orientiere dich am Schaltplan, den Rest musst du selbst herausfinden.
+
+
+## PCB Layout-Parameter
+
+Wenn du dich für einen Hersteller entscheidest, solltest du sicherstellen, dass
+folgende Layoutparameter unterstützt sind. In der Regel listet jeder Hersteller
+auf der Website diese Informationen auf, und die Minimal- und Maximalgrößen
+dürfen nicht unter- bzw. überschritten werden, sonst könnte die Herstellung
+fehlschlagen.
+
+Wir verwenden in unseren Designs:
+
+* TODO: Via size, minimum trace width, milling path restrictions
+
+## Gerber-Dateien
+
+TODO: Wo sind die Dateien zu finden?