fix missing pip in docs container and add reference to v2 docs in readme

ctag-fh-kiel · Dec 16, 2024 · 107497f · 107497f
1 parent 7cd7cb1
commit 107497f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/docs/config/tbd_docs.Dockerfile b/docs/config/tbd_docs.Dockerfile
@@ -5,6 +5,7 @@ ENV TBD_BUILD_DIR=/code/build
 
 WORKDIR /code
 RUN python3 -m pip install \
+    furo \
     pydata-sphinx-theme \
     sphinxcontrib-youtube \
     breathe

diff --git a/docs/index.rst b/docs/index.rst
@@ -2,9 +2,7 @@
 CTAG TBD hackable audio processor
 #################################
 
-Hardware reference designs and sof
-
-tware suite for a series of highly hackable electronic musical devices, built around the 
+Hardware reference designs and software suite for a series of highly hackable electronic musical devices, built around the 
 **ESP32** family of systems on a chip (SoC).
 
 Everything to build your own audio processor device for MIDI or Eruorack. Add sounds and plugins, extend, hack, redesign 

diff --git a/readme.md b/readme.md
@@ -1,9 +1,13 @@
 # **CTAG TBD >>to be determined<<**
 ![build docs](/~https://github.com/ctag-fh-kiel/ctag-tbd/workflows/build_docs/badge.svg)
 
+A hackable fully open source universal music and sound machine based on the esp32 family of SoC
+
 ![CTAG-TBD](tbd.png)
 
-![docs build](/~https://github.com/ctag-fh-kiel/ctag-tbd/actions/workflows/build_docs.yml/badge.svg)
+> [!NOTE]  
+> Find a sneak preview of the documentation for the upcoming TBD v2 docs [here](https://ctag-fh-kiel.github.io/)
+
 
 ## Documentation (in the works):
 [Summary table](https://docs.google.com/spreadsheets/d/1dBZtuBIdtgMqoRruYX-VDdDirdTQ6RD-oz-j79q-bmQ/edit?usp=sharing) of all available plugins.