From 996ee12aa51c8279257991d76d11c14e7e0302f6 Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Sun, 28 Jan 2024 13:33:58 +0100
Subject: doc: Add new chapter 'Developer documentation'

This new chapter should be the one with the highest level of details.
The section about versioning is also moved there with this commit.
---
 doc/documentation.tex | 50 +++++++++++++++++++++-----------------------------
 1 file changed, 21 insertions(+), 29 deletions(-)

(limited to 'doc/documentation.tex')

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 6448186..d1a7788 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -24,29 +24,6 @@
 
 \texttt{soundbox} is a device to connect classic audio systems to the network.
 
-\section{Versioning}
-
-This device is versioned with Semantic
-Versioning\footnote{\href{https://semver.org}{https://semver.org}}. The
-resulting version numbers have the format \texttt{<major>.<minor>.<patch>} like
-e.g. \texttt{2.0.3}. While Semantic Versioning is usually targeted at software
-only it is here used for the whole device. This includes mechanical, electronic
-and software aspects as shown in figure \ref{diagram:device-semver}.
-
-\begin{figure}[h]
-	\centering
-	\includegraphics[width=\textwidth]{device-semver.pdf}
-	\caption{API for a device versioned with Semantic Versioning}
-	\label{diagram:device-semver}
-\end{figure}
-
-This versioning makes sure that users do not have to care about the device
-internals at all. Devices can be seen as atomic from a user's perspective. This
-level of granularity is choosen because users are not expected to disassemble
-devices or to care about the software internals.
-
-%\section{Licensing}
-
 \chapter{User guide}
 
 In addition to \autoref{chap:introduction} `\nameref{chap:introduction}` the
@@ -334,12 +311,27 @@ reboot
 After this reboot the soundbox device should be able to play audio like
 described in section~\ref{playing-audio}.
 
-%\section{Final assembly}
+\chapter{Developer documentation}
+
+\section{Versioning}
 
-%\chapter{Device internals}
-%\section{Mechanical design}
-%\section{Electronics}
-%\section{Operating system}
-%\section{Software}
+This device is versioned with Semantic
+Versioning\footnote{\href{https://semver.org}{https://semver.org}}. The
+resulting version numbers have the format \texttt{<major>.<minor>.<patch>} like
+e.g. \texttt{2.0.3}. While Semantic Versioning is usually targeted at software
+only it is here used for the whole device. This includes mechanical, electronic
+and software aspects as shown in figure \ref{diagram:device-semver}.
+
+\begin{figure}[h]
+	\centering
+	\includegraphics[width=\textwidth]{device-semver.pdf}
+	\caption{API for a device versioned with Semantic Versioning}
+	\label{diagram:device-semver}
+\end{figure}
+
+This versioning makes sure that users do not have to care about the device
+internals at all. Devices can be seen as atomic from a user's perspective. This
+level of granularity is choosen because users are not expected to disassemble
+devices or to care about the software internals.
 
 \end{document}
-- 
cgit v1.2.3-70-g09d2

