summaryrefslogtreecommitdiff
path: root/doc/documentation.tex
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-28 13:33:58 +0100
committerxengineering <me@xengineering.eu>2024-01-28 13:33:58 +0100
commit996ee12aa51c8279257991d76d11c14e7e0302f6 (patch)
tree80dd87c89e958450d2635f582a75f063965ec7c6 /doc/documentation.tex
parent62d68edfef3afaae315c020f20e0cc6ff7ad5719 (diff)
downloadsoundbox-996ee12aa51c8279257991d76d11c14e7e0302f6.tar
soundbox-996ee12aa51c8279257991d76d11c14e7e0302f6.tar.zst
soundbox-996ee12aa51c8279257991d76d11c14e7e0302f6.zip
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.
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r--doc/documentation.tex50
1 files changed, 21 insertions, 29 deletions
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}