docs: Update URLs to the project repository, since it moved

theacodes · theacodes · commit 97f7345a40a6 · 2021-07-07T23:23:12.000-04:00
diff --git a/user_guide/docs/index.md b/user_guide/docs/index.md
@@ -6,10 +6,9 @@ Big Honking Button is, well, a big button that honks. Okay, that's not all- it
 
 We want you to have a wonderful experience with your module. If you need help or run into problems, please reach out to us. Email is the best way for product issues, whereas Discord and GitHub are great for getting advice and help on how to customize your module.
 
-* Send us [an email](mailto:support@winterbloom.com).
-* File a bug [on GitHub](https://github.com/theacodes/Winterbloom-Big-Honking-Button)
-* Reach out on the [Discord][discord]
-
+-   Send us [an email](mailto:support@winterbloom.com).
+-   File a bug [on GitHub](https://github.com/wntrblm/Big_Honking_Button/issues)
+-   Reach out on the [Discord][discord]
 
 ## Installing the module
 
@@ -18,27 +17,24 @@ To install this into your Eurorack setup:
 1. Connect a Eurorack power cable to your power supply and the back of the module. **Note that even though the power connector on the module is keyed, double check that the red stripe is on the side labeled `red stripe`!**
 1. Screw the module to your rack's rails.
 
-
 ## Inputs and outputs
 
 ![images/honk-program-labels.png](images/honk-program-labels.png)
 
 Big Honking Button has two inputs:
 
-- A gate / trigger in
-- A pitch CV in that is 1v/Oct with a -5v to +5v range<sup>see note</sup>
+-   A gate / trigger in
+-   A pitch CV in that is 1v/Oct with a -5v to +5v range<sup>see note</sup>
 
 And two outputs:
 
-- A gate / trigger out (0v or 5v)
-- An audio out
-
+-   A gate / trigger out (0v or 5v)
+-   An audio out
 
 With the default code, it will trigger the sample and play it through the audio out whenever the button is pressed or whenever the gate input is triggered. It will also set the gate out to high whenever the button is pressed or whenever the gate in is high. You can customize some of this behavior by [modifying the code](#modifying-the-code).
 
 !!! note "Revision differences"
-    Big Honking Buttons manufactured prior to 2021 (v4 and lower) only have an input range of -2v to +2v. More than that won't damage the module, but it won't be able to measure anything outside of that range.
-
+Big Honking Buttons manufactured prior to 2021 (v4 and lower) only have an input range of -2v to +2v. More than that won't damage the module, but it won't be able to measure anything outside of that range.
 
 ## Changing the sample
 
@@ -57,14 +53,13 @@ Your Big Honking Button will reboot and then it should play the new sample! If y
 
 You can store and play multiple samples on the Big Honking Button, but to do that, you'll need to learn how to modify some of the code - don't worry! It's not too hard.
 
-
 ## Modifying the code
 
-When connected to your computer, Big Honking Button shows up as a small drive named `CIRCUITPY`. In that drive, you should find a file named `code.py`. Big Honking Button runs [CircuitPython][CircuitPython] which means that its firmware is written in the approachable [Python](https://python.org) programming language and you don't need any special knowledge or compilers to make changes to it. So, open up that file in your favorite text editor, we're going to make some changes!
+When connected to your computer, Big Honking Button shows up as a small drive named `CIRCUITPY`. In that drive, you should find a file named `code.py`. Big Honking Button runs [CircuitPython][circuitpython] which means that its firmware is written in the approachable [Python](https://python.org) programming language and you don't need any special knowledge or compilers to make changes to it. So, open up that file in your favorite text editor, we're going to make some changes!
 
 If you don't have a text editor - that's okay! While you could use Notepad (Windows) or TextEdit (Mac), these can sometimes have issues with CircuitPython devices like Big Honking Button. I'd recommend [installing Mu](https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor) if you're new to this whole world. You can read more about editing code for CircuitPython in [Adafruit's guide](https://learn.adafruit.com/welcome-to-circuitpython/creating-and-editing-code).
 
-As a way to get your feet let's change how the Big Honking Button behaves. By default, when you press the button it plays the *entire* sample, even if you release the button while the sample is still playing (this is **trigger mode**). This will make it where the sample will stop as soon as you let go of the button (or **gate** mode).
+As a way to get your feet let's change how the Big Honking Button behaves. By default, when you press the button it plays the _entire_ sample, even if you release the button while the sample is still playing (this is **trigger mode**). This will make it where the sample will stop as soon as you let go of the button (or **gate** mode).
 
 In the `code.py` you should see some code that looks like this (it's at the bottom):
 
@@ -87,30 +82,28 @@ if bhb.released:
 ```
 
 !!! warning "Be careful"
-    Python is *whitespace-sensitive*. That means tabs and spaces are important! Make sure that you don't accidentally change the indentation level of this line.
+    Python is _whitespace-sensitive_. That means tabs and spaces are important! Make sure that you don't accidentally change the indentation level of this line.
 
 Okay, save the file! Your Big Honking Button should restart and now it should stop the sample as soon as you let go of the button, try pressing it rapidly to see the effect.
 
 !!! note "Tip"
     If things aren't working, see the section below on finding problems or [reach out](#getting-support-and-help)!
 
-**Congrats**, you've made your first change to how the module works!  🎉
+**Congrats**, you've made your first change to how the module works! 🎉
 
 Big Honking Button can store multiple samples and you can use various means to change how they're triggered. We'll be adding a sample showing just that soon, but don't be afraid to experiment and reach out if you need any help!
 
 If you want to you can learn more about [CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/overview) to the most of your module. Also, please come chat on the [Discord][discord] where you can ask questions and see what others are doing with their Big Honking Button!
 
-
 ## Examples
 
-Big Honking Button can do all sorts of things! We've made a few examples to get you started. If you want to use these, copy their contents to `code.py` on the `CIRCUITPY` drive. **Be sure to save it as the correct name,** if you don't name it `code.py` it won't change anything. If you want to restore the original `code.py` it is [here](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/default.py).
-
-1. [Cycle example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/cycle.py): Shows how to load multiple samples and cycle between them.
-1. [Random example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/random.py): Shows how to load multiple samples and choose one at random.
-1. [Tap tempo example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/tap_tempo.py): Shows how to use the button to set the tempo and have the module play back a sample at each beat.
-1. [Sine example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/sine.py): An advanced example that shows how to generate a custom waveform.
-1. [Noise example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/noise.py): An advanced example that shows how to generate noise.
+Big Honking Button can do all sorts of things! We've made a few examples to get you started. If you want to use these, copy their contents to `code.py` on the `CIRCUITPY` drive. **Be sure to save it as the correct name,** if you don't name it `code.py` it won't change anything. If you want to restore the original `code.py` it is [here](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/default.py).
 
+1. [Cycle example](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/cycle.py): Shows how to load multiple samples and cycle between them.
+1. [Random example](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/random.py): Shows how to load multiple samples and choose one at random.
+1. [Tap tempo example](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/tap_tempo.py): Shows how to use the button to set the tempo and have the module play back a sample at each beat.
+1. [Sine example](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/sine.py): An advanced example that shows how to generate a custom waveform.
+1. [Noise example](https://github.com/wntrblm/Big_Honking_Button/blob/main/examples/noise.py): An advanced example that shows how to generate noise.
 
 ## Help! I changed some code and this thing isn't working!
 
@@ -133,11 +126,10 @@ Updating the firmware requires two steps: Updating CircuitPython and updating Bi
 
 ### Updating Big Honking Button's libraries
 
-1. [Download the latest release bundle for Big Honking Button](https://github.com/theacodes/Winterbloom-Big-Honking-Button/releases).
+1. [Download the latest release bundle for Big Honking Button](https://github.com/wntrblm/Big_Honking_Button/releases).
 2. Unzip the release bundle, and then copy the contents to Big Honking Button's `CIRCUITPY` drive, replacing any existing files.
 3. Reboot Big Honking Button by power cycling your synthesizer or pressing the reset button again.
 
-
 <!-- ## Frequently asked questions
 
 Got a question not answered here? [Reach out](#getting-support-and-help), we'll be happy to help! -->
@@ -146,13 +138,12 @@ Got a question not answered here? [Reach out](#getting-support-and-help), we'll
 
 Big Honking Button is completely open source and hacking is encouraged.
 
-* The [firmware](https://github.com/theacodes/Winterbloom-Big-Honking-Button/tree/master/firmware) is available under the [MIT License](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/firmware/LICENSE).
-* The [hardware design](https://github.com/theacodes/Winterbloom-Big-Honking-Button/tree/master/hardware) is available under the [CC BY-SA 4.0 License](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/hardware/LICENSE) and is designed using [KiCAD](https://kicad.org/) which is free and open-source. You can open the hardware files using KiCAD or you can check out a [PDF of the schematic](https://github.com/theacodes/Winterbloom-Big-Honking-Button/raw/master/hardware/board/board.pdf).
-* [CircuitPython][CircuitPython] is available under the [MIT License](https://github.com/adafruit/circuitpython/blob/main/LICENSE).
+-   The [firmware](https://github.com/wntrblm/Big_Honking_Button/tree/main/firmware) is available under the [MIT License](https://github.com/wntrblm/Big_Honking_Button/blob/main/firmware/LICENSE).
+-   The [hardware design](https://github.com/wntrblm/Big_Honking_Button/tree/main/hardware) is available under the [CC BY-SA 4.0 License](https://github.com/wntrblm/Big_Honking_Button/blob/main/hardware/LICENSE) and is designed using [KiCAD](https://kicad.org/) which is free and open-source. You can open the hardware files using KiCAD or you can check out a [PDF of the schematic](https://github.com/wntrblm/Big_Honking_Button/raw/main/hardware/board/board.pdf).
+-   [CircuitPython][circuitpython] is available under the [MIT License](https://github.com/adafruit/circuitpython/blob/main/LICENSE).
 
 ![Open Source Hardware Association mark](images/oshw.svg){class=oshw} Big Honking Button is [certified open source hardware](https://certification.oshwa.org/us000678.html).
 
-
 ## Warranty, disclaimers, and limits
 
 Modules purchased from Winterbloom have a warranty of six months from the date of purchase. This warranty covers any manufacturing defects in the module. It does not cover damage from due to incorrect handling, storage, or power, overvoltage events, or modifications.
@@ -163,11 +154,9 @@ Because Eurorack has a vast number of possible combinations of power supplies, m
 
 We encourage tinkering, however, we will not refund, repair, or replace any products that have been modified.
 
-
 ## Acknowledgments and thanks
 
 Big Honking Button would not be possible without the help of the CircuitPython community and Adafruit Industries.
 
-
-[CircuitPython]: https://circuitpython.org
+[circuitpython]: https://circuitpython.org
 [discord]: https://discord.gg/UpfqghQ
diff --git a/user_guide/mkdocs.yml b/user_guide/mkdocs.yml
@@ -1,26 +1,26 @@
 site_name: Winterbloom Big Honking Button User Guide
+site_url: https://honk.wntr.dev
 copyright: "© 2020 Winterbloom, licensed under Creative Commons CC BY-SA 4.0"
-repo_url: "https://github.com/theacodes/Winterbloom-Big-Honking-Button"
+repo_url: "https://github.com/wntrblm/Big_Honking_Button"
 edit_uri: edit/main/user_guide/docs
 theme:
-  name: winterbloom
+    name: winterbloom
 markdown_extensions:
-  - admonition
-  - def_list
-  - attr_list
-  - toc:
-      permalink: "#"
-      toc_depth: 2
-  - pymdownx.highlight:
-      use_pygments: True
-  - pymdownx.superfences
-  - pymdownx.magiclink
-  - md_in_html
-  - markdown_link_attr_modifier:
-      external_only: True
-      custom_attrs:
-        rel: "noopener"
-        referrerpolicy: "origin"
+    - admonition
+    - def_list
+    - attr_list
+    - toc:
+          permalink: "#"
+          toc_depth: 2-3
+    - pymdownx.highlight:
+          use_pygments: True
+    - pymdownx.superfences
+    - pymdownx.magiclink
+    - md_in_html
+    - markdown_link_attr_modifier:
+          new_tab: "external_only"
+          custom_attrs:
+              referrerpolicy: "origin"
 nav:
-  - "User Guide": index.md
-  - "Kit Build Instructions": build.md
+    - "User Guide": index.md
+    - "Kit Build Instructions": build.md
