Refactor docs in preparation for docgen

gopxl · Oct 20, 2024 · 674c61d · 674c61d
1 parent 86a0dfb
commit 674c61d
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 6 deletions.
diff --git a/docs/Home.md → docs/Tutorial/01. Home.md b/docs/Home.md → docs/Tutorial/01. Home.md
diff --git a/docs/Hello,-Beep!.md → docs/Tutorial/02. Hello, Beep!.md b/docs/Hello,-Beep!.md → docs/Tutorial/02. Hello, Beep!.md
@@ -1,3 +1,5 @@
+# Hello, Beep!
+
 Welcome to the Beep tutorial! In this part, we'll learn how to load a song, initialize the speaker, and wake up your neighbors.
 
 The first thing we obviously need is the [Beep library](https://github.com/gopxl/beep/) (I expect you have the Go programming language installed), which you can install with this command:

diff --git a/docs/Composing-and-controlling.md → ...Tutorial/03. Composing and Controlling.md b/docs/Composing-and-controlling.md → ...Tutorial/03. Composing and Controlling.md
@@ -1,3 +1,5 @@
+# Composing and Controlling
+
 In this part, we'll learn how to compose new, more complex streamers out of simpler ones and how to control their playback.
 
 We'll start roughly where we left off in the previous part (excluding the resampling). If you don't have the code, here it is:

diff --git a/docs/Making-own-streamers.md → docs/Tutorial/04. Making Own Streamers.md b/docs/Making-own-streamers.md → docs/Tutorial/04. Making Own Streamers.md
@@ -1,3 +1,5 @@
+# Making own streamers
+
 Beep offers a lot of pre-made streamers, but sometimes that's not enough. Fortunately, making new ones isn't very hard and in this part, we'll learn just that.
 
 So, what's a streamer? It's this interface:

diff --git a/...or-not-to-buffer,-that-is-the-question.md → ...torial/04. To Buffer, or Not To Buffer.md b/...or-not-to-buffer,-that-is-the-question.md → ...torial/04. To Buffer, or Not To Buffer.md
@@ -1,3 +1,5 @@
+# To buffer, or not to buffer, that is the question
+
 The root data source of all audio we've worked with so far was an audio file. The audio file had to be open the whole time its content was being played over the speaker. Obviously, this isn't always desirable. A good example is a gunshot sound effect in an action game. It's a small file, there's no reason to stream it directly from the disk. It's much better to have it loaded in memory. Furthermore, there may be gunshots all over the place. Decoding a file gives us only one streamer, which limits us to only one gunshot sound playing at any moment. We could open the file multiple times, but you can surely see that's a wrong way to do it.
 
 In this part, we'll learn how to load a sound to memory and then stream it from there.

diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md