Documention: Restore documenation

This commit should restore the balena-sound docs to working order They have presently fallen into a state of code-rot due to no index.html file at the root of the /docs directory The landing page is rather bare-bones at the moment, but it can be enhanced later once it is at least present. Connects-to: #658 Change-type: patch Signed-off-by: Maximilien McDermott [email protected]
balena-io-experimental · Apr 9, 2024 · ed7ca0e · ed7ca0e
1 parent f87ed51
commit ed7ca0e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,3 @@
+# Build settings
+markdown: karmdown # parser for your markdown files
+source: ./ # the source directory for your files
diff --git a/docs/docusaurus-config.yml b/docs/docusaurus-config.yml
@@ -1,3 +1,3 @@
 project:
   # Set the name that will appear in the header of the documentation
-  name: "Balena Sound"
+  name: "Balena Sound"
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Welcome to Balena Sound! This project began life as a Balena Hackathon, and the project is now maintained by the community! Please explore, participate, and be kind to maintainers, Balena employees, and each other. We're all hobbyists here.</title>
+  </head>
+  <body>
+    <ul>
+      <li><a href="01-getting-started.html">Getting Started</a></li>
+      <li><a href="02-usage.html">Usage</a></li>
+      <li><a href="03-customization.html">Customization</a></li>
+      <li><a href="04-plugins.html">Plugins</a></li>
+      <li><a href="05-audio-interfaces.html">Audio Interfaces</a></li>
+      <li><a href="06-device-support.html">Device Support</a></li>
+      <li><a href="07-support.html">Support</a></li>
+    </ul>
+  </body>
+</html>