starting to restructure the doc (#25)

* starting to restructure the doc * adding missing content to index * adding stuff about the SW platform
LydByDissing · Jul 11, 2022 · 2b01cdf · 2b01cdf
1 parent 71d5f76
commit 2b01cdf
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 26 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -5,8 +5,5 @@ Contribution Guideline
 
 The following document describes how to contribute to the STRØM 1.0 project.
 
-The CC BY-NC-SA 4.0 license
-***************************
-
 .. include:: ../../CONTRIBUTING.md
    :parser: myst_parser.sphinx_
diff --git a/docs/source/guides/index.rst b/docs/source/guides/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,6 +14,11 @@ The *Strøm* open source speaker project have been started with the main goal of
   user-documentation/index
   repair
   end-of-life
+<<<<<<< HEAD
+  speaker/index
+  software/index
+=======
+>>>>>>> 71d5f7664e155b94b3970c8661792f65731da612
   contributing
   license
   todo
@@ -57,7 +62,7 @@ Contributing to the project
 ***************************
 
 Interested in contributing to the project? Then please take a quick look at the contribution guideline beforehand.
-You find the contribution :ref:`here <contribution guideline>` and in the GitHub repo as well: `LydByDissing/stroem/CONTRIBUTING.md <https://github.com/LydByDissing/stroem/blob/main/CONTRIBUTING.md>`_.
+You find the contribution guide :ref:`here <contribution guideline>` and in the GitHub repo as well: `LydByDissing/stroem/CONTRIBUTING.md <https://github.com/LydByDissing/stroem/blob/main/CONTRIBUTING.md>`_.
 
 Last updated
 ************

diff --git a/docs/source/software/bluetooth.rst b/docs/source/software/bluetooth.rst
@@ -1,3 +1,5 @@
+.. _bluetooth:
+
 =========
 Bluetooth
 =========

diff --git a/docs/source/software/index.rst b/docs/source/software/index.rst
@@ -2,9 +2,11 @@
 The Software Platform
 *********************
 
-This speaker is capable of playing audio through `Bluetooth <https://www.bluetooth.com>`_ and `Spotify Connect <https://www.spotify.com/us/connect/>`_. Both require a software stack to be install on the main board.
+This speaker is capable of playing audio through :ref:`Bluetooth <bluetooth>` and :ref:`Spotify Connect <spotify-connect>`, as well as other sources.
+All of this are handled by the software platform called `Euphonium <https://github.com/feelfreelinux/euphonium>`_. This is a separate project on GitHub and it can be used for other types of platforms. Not just this ESP32 based setup. Read more in this projects documentation.
 
 .. toctree::
+   :caption: Capabilities
    :maxdepth: 1
    :glob:
 

diff --git a/docs/source/software/spotify-connect.rst b/docs/source/software/spotify-connect.rst
@@ -1,3 +1,5 @@
+.. _spotify-connect:
+
 ===============
 Spotify Connect
 ===============

diff --git a/docs/source/software/web-radio.rst b/docs/source/software/web-radio.rst
@@ -0,0 +1,7 @@
+=========
+Web Radio
+=========
+
+There's integration to web radio playback, making it easy to select most online available web radios.
+
+Simply search in the UI, for your favorite station and select play.
diff --git a/docs/source/speaker/index.rst b/docs/source/speaker/index.rst
@@ -1,6 +1,6 @@
-***************
-Speaker Cabinet
-***************
+**************************
+Speaker Parts and Assembly
+**************************
 
 The speaker cabinet are constructed from MDF, as this material is well suited for this type of application. Both the low internal damping, as well as the ease of processing, of this material makes it a good choice for constructing speaker cabinets.
 

diff --git a/docs/source/speaker/parts/index.rst b/docs/source/speaker/parts/index.rst
@@ -1,4 +1,4 @@
-Cabinet parts
+Speaker parts
 #############
 
 .. toctree::
@@ -7,13 +7,13 @@ Cabinet parts
 
    *
 
-Generate a parts ID
-===================
+Generate a parts ID when adding a new part
+==========================================
 
 To generate a ID for a part, follow the below example. The following tool is used: `Short UUID <https://github.com/simplyhexagonal/short-unique-id>`_.
 
 .. code-block:: bash
 
   suid -l 6 -d utils/uuid-dict.json
 
-Please note that a simplified `dictionary <https://raw.githubusercontent.com/LydByDissing/stroem/main/uuid-dict.json>`_ have been used to ensure only uppercase characters are used.
+Please note that a simplified `dictionary <https://raw.githubusercontent.com/LydByDissing/stroem/main/utils/uuid-dict.json>`_ have been used to ensure only uppercase characters are used.
diff --git a/docs/source/user-documentation/index.rst b/docs/source/user-documentation/index.rst
@@ -9,3 +9,4 @@ User Documentation
    :glob:
 
    *
+   voicing/*
diff --git a/...t-initial-filters-frequency-response.json → ...t-initial-filters-frequency-response.json b/...t-initial-filters-frequency-response.json → ...t-initial-filters-frequency-response.json
diff --git a/...-target-no-filter-frequency-response.json → ...-target-no-filter-frequency-response.json b/...-target-no-filter-frequency-response.json → ...-target-no-filter-frequency-response.json
diff --git a/docs/source/guides/frequency-response.json → ...mentation/voicing/frequency-response.json b/docs/source/guides/frequency-response.json → ...mentation/voicing/frequency-response.json
diff --git a/docs/source/guides/voicing.rst → ...ce/user-documentation/voicing/voicing.rst b/docs/source/guides/voicing.rst → ...ce/user-documentation/voicing/voicing.rst
@@ -20,7 +20,7 @@ With the Strøm speaker several design goals have been defined (see more in the
 
 The following acoustic design goals have been set for the speaker:
 
-.. include:: ../requirements.rst
+.. include:: ../../requirements.rst
   :start-after: acoustic-requirements-start
   :end-before: acoustic-requirements-end
 
@@ -59,7 +59,7 @@ Here's the speaker measured before voicing. A single 8th order high pass (HP) fi
 
 The frequency and phase response are depicted. It is worth noting that the results haven't been normalize, resulting in that the measured dB can't be related to anything (other than other measurements using the same setup).
 
-.. chart:: guides/80hz-target-no-filter-frequency-response.json
+.. chart:: user-documentation/voicing/80hz-target-no-filter-frequency-response.json
 
     Measured frequency response of an initial test cabinet. Primarily used for validation of the internal cabinet volume.
 
@@ -71,7 +71,7 @@ As a developement workflow I am using the great `HEnquist/camilladsp <https://gi
 
 As we can't make the bass higher – without additional :math:`X_{max}` of the driver - we need to lower the rest of the frequency response. This will lower the overall efficiency of the speaker, but result in a much more linear frequency response. See the below graph for a measurement of the inital filters applied to the signal chain.
 
-.. chart:: guides/80hz-target-initial-filters-frequency-response.json
+.. chart:: user-documentation/voicing/80hz-target-initial-filters-frequency-response.json
 
     Measurement result when initial filtering have been applied.