some markdown tweaks; add changelog/contributing/coc; rewrite paths in readme

Author: dromer

README.md

@@ -74,7 +74,7 @@ cd hvcc/
 pip3 install -e .
 ```
 
-Also review our [Contribution Guide](/CONTRIBUTING.md) before opening a pull request.
+Also review our [Contribution Guide](CONTRIBUTING.md) before opening a pull request.
 
 ## Usage
 
@@ -168,7 +168,7 @@ Displays all the available parameters and options for hvcc.
 
 ## Contact
 
-The Heavy community aims to be safe and inclusive, please read our [Code of Conduct](/CODE_OF_CONDUCT.md) before engaging.
+The Heavy community aims to be safe and inclusive, please read our [Code of Conduct](CODE_OF_CONDUCT.md) before engaging.
 
 There are several places where heavy/hvcc conversation is happening:
 

docs/adr/ADR-003-Control-Rate-Expr.md

@@ -1,6 +1,7 @@
 # ADR-003: Control Rate Expr
 
 Date: 2025-12-05
+
 Issue: https://github.com/Wasted-Audio/hvcc/issues/21
 
 ## Context

docs/adr/ADR-004-Signal-Rate-Expr.md

@@ -1,6 +1,7 @@
 # ADR-004: Signal Rate Expr
 
 Date: 2025-12-05
+
 Issue: https://github.com/Wasted-Audio/hvcc/issues/21
 
 ## Context

docs/generators/unity.md

@@ -169,7 +169,7 @@ The android NDK comes with a `<NDK>/build/cmake/android.toolchain.cmake` file th
 
 From the hvcc export `unity` directory containing the `CMakeLists.txt`.
 
-```
+```shell
 cmake -S . -B cmake-build-android -G Ninja \ 
     -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake \
     -DANDROID_ABI=arm64-v8a \
@@ -185,13 +185,13 @@ https://docs.unity3d.com/Manual/PluginInspector.html
 
 iOS builds are unique in that the source code is needed when compiling the Unity game for the device.
 
-Once the game is working as expected in the Unity editor (the macos plugins are required for that) and the heavy C# scripts are correctly attached to the gameobjects, go to `File` > `Build Settings` in the Unity menu. Then generate the Xcode project by selecting iOS platform, adding the required scenes and clicking `Build`.
+Once the game is working as expected in the Unity editor (the macos plugins are required for that) and the heavy C# scripts are correctly attached to the gameobjects, go to `File > Build Settings` in the Unity menu. Then generate the Xcode project by selecting iOS platform, adding the required scenes and clicking `Build`.
 
 Open the Xcode project from the directory previously selected in Unity's build menu.
 
 Create a new group in the left-hand side Project explorer section, the group name is not important but in this case we'll called it `heavy`.
 
-Download the [Unity source target](../getting-started/patching.md#using-the-generated-targets)  from the patch compile page and copy the contents of the `source/heavy/` folder into the `heavy` Xcode group that was created previously. Make sure to copy every file.
+Download the Unity source target from the patch compile page and copy the contents of the `source/heavy/` folder into the `heavy` Xcode group that was created previously. Make sure to copy every file.
 
 ![unity_ios_xcode](../img/docs_unity_ios_xcode.png)
 

docs/generators/wwise.md

@@ -18,7 +18,7 @@ Heavy currently supports the following Wwise features:
 
 ## Source Generator or FX Unit
 
-The type of plugin that **heavy** generates is dynamically determined depending on the [I/O channel configuration](../getting-started/patching.md#audio-input-output). If an `[adc~]` object exists in the patch the generated plugin with be an FX unit. Otherwise it'll be a source generator plugin.
+The type of plugin that **heavy** generates is dynamically determined depending on the [I/O channel configuration](../getting-started/patching.md#audio-inputoutput). If an `[adc~]` object exists in the patch the generated plugin with be an FX unit. Otherwise it'll be a source generator plugin.
 
 ## RTPCs
 

docs/getting-started/index.md

@@ -65,7 +65,7 @@ The files that `hvcc` generates are split into two types:
 
 - [Static](https://github.com/Wasted-Audio/hvcc/tree/master/hvcc/generators/ir2c/static): this code is independent of the input patch contents and provides the basic DSP functionality with which generated output can link against. It has a liberal [ISC](https://github.com/Wasted-Audio/hvcc/blob/master/hvcc/generators/ir2c/static/HeavyContext.hpp#L2) licence.
 
-- Generated: this relates to all the source files that use information about the input patch, for example `Heavy_{{name}}.cpp`. By default all these files will have a `Copyright (c) 2018 Enzien Audio, Ltd` header, but this can be modified with the [user copyright argument](../index.md#--copyright-user-copyright).
+- Generated: this relates to all the source files that use information about the input patch, for example `Heavy_{{name}}.cpp`. By default all these files will have a `Copyright (c) 2018 Enzien Audio, Ltd` header, but this can be modified with the [user copyright argument](../index.md#-copyright-user-copyright).
 
 ## How to start patching for heavy
 

docs/mkdocs_hooks.py

@@ -1,13 +1,20 @@
-import os
-import re
+import re, os
 
 
 def python_indent(content):
-    # Pattern: classic markdown indent (2 spaces) to Python-Markdown indent (4 spaces)
-    return re.sub(r'^(\ \ -\ .*)', r'  \1', content, flags=re.MULTILINE)
+    """ Pattern: classic markdown indent (2 spaces) to Python-Markdown indent (4 spaces)
+        Handle both single and double indent. In reverse so we don't overwrite.
+    """
+    # double
+    content = re.sub(r'^(\ \ \ \ -\ .*)', r'    \1', content, flags=re.MULTILINE)
+    # single
+    content = re.sub(r'^(\ \ -\ .*)', r'  \1', content, flags=re.MULTILINE)
 
+    return content
 
-def on_page_markdown(markdown, page, config, files):
+
+def on_page_markdown(markdown: str, page, config, files):
+    print(page.file.src_path)
     if page.file.src_path == 'index.md':
         readme_path = os.path.join(os.path.dirname(config['config_file_path']), 'README.md')
         try:
@@ -23,10 +30,18 @@ def on_page_markdown(markdown, page, config, files):
 
             content = python_indent(content)
 
+            # file paths
+            content = content.replace('CONTRIBUTING.md', 'about/contributing.md')
+            content = content.replace('CODE_OF_CONDUCT.md', 'about/code_of_conduct.md')
+
             return content
         except Exception as e:
             print(f"Error including README.md: {e}")
             return markdown
 
+    elif page.file.src_path == 'about/contributing.md':
+        markdown = markdown.replace('CHANGELOG.md', 'about/changelog.md')
+        return markdown
+
     markdown = python_indent(markdown)
     return markdown

mkdocs.yml

@@ -32,16 +32,16 @@ nav:
     - Patching Guide: getting-started/patching.md
   - Generators:
     - Overview: generators/index.md
-    - Unity: generators/unity.md
-    - Wwise: generators/wwise.md
     - Daisy:
       - Basics: generators/daisy.md
       - JSON Params: generators/daisy_json.md
     - DPF: generators/dpf.md
-    - Javascript: generators/javascript.md
     - FMOD: generators/fmod.md
+    - Javascript: generators/javascript.md
     - OWL: generators/owl.md
     - Pd External: generators/pdext.md
+    - Wwise: generators/wwise.md
+    - Unity: generators/unity.md
     - Custom: generators/custom.md
   - Reference:
     - MIDI: reference/midi.md
@@ -54,7 +54,11 @@ nav:
     - Heavy GUI IR: reference/ir/heavy_gui_ir.md
   - ADRs:
     - Overview: adr/index.md
-    - GUI Send/Receive: adr/ADR-001-GUI-Send-Receive.md
-    - pd2gui Parser: adr/ADR-002-pd2gui-Parser.md
-    - Control Rate Expr: adr/ADR-003-Control-Rate-Expr.md
-    - Signal Rate Expr: adr/ADR-004-Signal-Rate-Expr.md
+    - 001 - GUI Send/Receive: adr/ADR-001-GUI-Send-Receive.md
+    - 002 - pd2gui Parser: adr/ADR-002-pd2gui-Parser.md
+    - 003 - Control Rate Expr: adr/ADR-003-Control-Rate-Expr.md
+    - 004 - Signal Rate Expr: adr/ADR-004-Signal-Rate-Expr.md
+  - About:
+    - Contributing: about/contributing.md
+    - Code Of Conduct: about/code_of_conduct.md
+    - Changelog: about/changelog.md