Docs: Fixes docs UI bugs & update links

.github/workflows/build-deploy-docs.yml

@@ -3,15 +3,17 @@ name: 🥘 Build & Deploy Docs HB
 on:
   pull_request:
     branches:
-      - main
+      - docs/deploy
+      - docs/deploy-test
     paths:
       # Trigger on changes to docs, mkdocs config, or the workflow itself
       - "docs/**"
       - "mkdocs.yml"
       - ".github/workflows/build-deploy-docs.yml"
   push:
     branches:
-      - main
+      - docs/deploy
+      - docs/deploy-test
     paths:
       # Trigger on changes to docs, mkdocs config, or the workflow itself
       - "docs/**"
@@ -52,6 +54,7 @@ jobs:
           . ~/otp-27.0/activate
           echo "Erlang version:"
           erl -eval 'io:format("~s~n", [erlang:system_info(otp_release)]), halt().'
+
       # Install system dependencies needed for HyperBEAM
       - name: Install system dependencies
         run: |
@@ -62,15 +65,19 @@ jobs:
             ncurses-dev \
             libssl-dev \
             ca-certificates
+
       # Debug step - display the region with syntax error
       - name: Debug syntax error region
         run: |
           echo "Showing the region with syntax error in hb_message.erl:"
           sed -n '1440,1460p' src/hb_message.erl || echo "File not found or cannot be read"
+
           echo "Checking for syntax error fix files:"
           find . -name "*.erl.fix" -o -name "hb_message.erl.*" | grep -v ".beam" || echo "No fix files found"
+
           echo "Erlang version:"
           . ~/otp-27.0/activate && erl -eval 'io:format("~s~n", [erlang:system_info(otp_release)]), halt().'
+
       # Install rebar3
       - name: Install rebar3
         run: |
@@ -79,12 +86,14 @@ jobs:
           curl -O https://s3.amazonaws.com/rebar3/rebar3 && chmod +x rebar3
           sudo mv rebar3 /usr/local/bin/rebar3
           . ~/otp-27.0/activate && rebar3 --version
+
       # Install Rust toolchain (needed for WASM components)
       - name: Install Rust and Cargo
         run: |
           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
           echo "$HOME/.cargo/bin" >> $GITHUB_PATH
           source "$HOME/.cargo/env"
+
       # Setup Node.js
       - name: ⎔ Setup Node
         uses: actions/setup-node@v3
@@ -96,13 +105,15 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
+
       - name: 🛠 Build Docs
         run: |
           . ~/otp-27.0/activate
           SKIP_COMPILE=1 SKIP_EDOC=1 ./docs/build-all.sh -v
+
   # Build and deploy the artifacts to Arweave via ArDrive
   deploy:
-    if: github.ref == 'refs/heads/main'
+    if: github.ref == 'refs/heads/docs/deploy' || github.ref == 'refs/heads/docs/deploy-test'
     runs-on: ubuntu-22.04
     # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
     # However, do NOT cancel in-progress runs as we want to allow these deployments to complete.
@@ -131,6 +142,7 @@ jobs:
           . ~/otp-27.0/activate
           echo "Erlang version:"
           erl -eval 'io:format("~s~n", [erlang:system_info(otp_release)]), halt().'
+
       # Install system dependencies needed for HyperBEAM
       - name: Install system dependencies
         run: |
@@ -141,15 +153,19 @@ jobs:
             ncurses-dev \
             libssl-dev \
             ca-certificates
+
       # Debug step - display the region with syntax error
       - name: Debug syntax error region
         run: |
           echo "Showing the region with syntax error in hb_message.erl:"
           sed -n '1440,1460p' src/hb_message.erl || echo "File not found or cannot be read"
+
           echo "Checking for syntax error fix files:"
           find . -name "*.erl.fix" -o -name "hb_message.erl.*" | grep -v ".beam" || echo "No fix files found"
+
           echo "Erlang version:"
           . ~/otp-27.0/activate && erl -eval 'io:format("~s~n", [erlang:system_info(otp_release)]), halt().'
+
       # Install rebar3
       - name: Install rebar3
         run: |
@@ -158,17 +174,20 @@ jobs:
           curl -O https://s3.amazonaws.com/rebar3/rebar3 && chmod +x rebar3
           sudo mv rebar3 /usr/local/bin/rebar3
           . ~/otp-27.0/activate && rebar3 --version
+
       # Install Rust toolchain (needed for WASM components)
       - name: Install Rust and Cargo
         run: |
           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
           echo "$HOME/.cargo/bin" >> $GITHUB_PATH
           source "$HOME/.cargo/env"
+
       # Install pip dependencies and cache them
       - name: 📦 Install Python dependencies
         run: |
           python -m pip install --upgrade pip
           pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
+
       # Setup Node.js (needed for npx deploy command)
       - name: ⎔ Setup Node
         uses: actions/setup-node@v3
@@ -184,20 +203,33 @@ jobs:
           VER=`node --version`; echo "Node ver:   $VER"
           VER=`npm --version`; echo "npm ver:    $VER"
           . ~/otp-27.0/activate && erl -eval 'io:format("Erlang OTP version: ~s~n", [erlang:system_info(otp_release)]), halt().'
+
       - name: 🛠 Build Docs
         id: build_artifacts
         run: |
           . ~/otp-27.0/activate
           SKIP_COMPILE=1 SKIP_EDOC=1 ./docs/build-all.sh -v
           touch mkdocs-site/.nojekyll
+
           echo "artifacts_output_dir=mkdocs-site" >> $GITHUB_OUTPUT
+
       - name: 💾 Publish to Arweave
         id: publish_artifacts
         run: |
-          npx permaweb-deploy \
-            --arns-name=dps-testing-facility \
-            --ant-process=${{ secrets.ANT_PROCESS }} \
-            --deploy-folder=${ARTIFACTS_OUTPUT_DIR}
+          if [[ "${{ github.ref }}" == "refs/heads/docs/deploy" ]]; then
+            echo "Deploying to production ArNS"
+            npx permaweb-deploy \
+              --arns-name=hyperbeam \
+              --ant-process=${{ secrets.ANT_PROCESS }} \
+              --deploy-folder=${ARTIFACTS_OUTPUT_DIR}
+          elif [[ "${{ github.ref }}" == "refs/heads/docs/deploy-test" ]]; then
+            echo "Deploying to preview ArNS undername"
+            npx permaweb-deploy \
+              --arns-name=hyperbeam \
+              --undername=preview \
+              --ant-process=${{ secrets.ANT_PROCESS }} \
+              --deploy-folder=${ARTIFACTS_OUTPUT_DIR}
+          fi
         env:
           DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
           ARTIFACTS_OUTPUT_DIR: ${{ steps.build_artifacts.outputs.artifacts_output_dir }}

.gitignore

@@ -1,3 +1,4 @@
+config.*
 .rebar3
 _build
 _checkouts

.vscode/launch.json

@@ -14,7 +14,7 @@
       "internalConsoleOptions": "openOnSessionStart",
       "module": "hb_debugger",
       "function": "start_and_break",
-      "args": "[${input:moduleName}, ${input:functionName}, [${input:funcArgs}]]"
+      "args": "[${input:moduleName}, ${input:functionName}, [${input:funcArgs}], <<\"${input:debuggerScope}\">>]"
     },
     {
       "name": "Attach to a 'rebar3 debugger' node.",
@@ -65,6 +65,11 @@
       "id": "funcArgs",
       "type": "promptString",
       "description": "(Optional) Pass arguments to the function:"
+    },
+    {
+      "id": "debuggerScope",
+      "type": "promptString",
+      "description": "(Optional) Additional modules/prefixes for debugger scope:"
     }
   ]
 }

README.md

@@ -79,7 +79,7 @@ rebar3 shell
 ```
 
 The default configuration uses settings from `hb_opts.erl`, which preloads 
-all devices and sets up default stores on port 10000.
+all devices and sets up default stores on port 8734.
 
 ### Optional Build Profiles
 
@@ -116,7 +116,7 @@ Note: Profiles modify compile-time options that get baked into the release. Choo
 To verify that your HyperBEAM node is running correctly, check:
 
 ```bash
-curl http://localhost:10000/~meta@1.0/info
+curl http://localhost:8734/~meta@1.0/info
 ```
 
 If you receive a response with node information, your HyperBEAM
@@ -135,7 +135,7 @@ The simplest way to configure HyperBEAM is using the `config.flat` file:
 2. Update to include your configuration values:
 
 ```
-port: 10000
+port: 8734
 priv_key_location: /path/to/wallet.json
 ```
 

docs/README.md

@@ -90,13 +90,19 @@ To contribute documentation to HyperBEAM, follow these steps:
      source venv/bin/activate
      pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
      ```
-   - Run the build script to verify your changes:
+   - Start the docs server
+     ```bash
+     mkdocs serve
+     ```
+
+6. **Build Your Changes**
+  - Run the build script to verify your changes:
      ```bash
      ./docs/build-all.sh
      ```
    - View the documentation locally at `http://127.0.0.1:8000/`
 
-6. **Submit a Pull Request**
+7. **Submit a Pull Request**
    - Create a new branch for your documentation changes
    - Commit your changes with a descriptive message
    - Submit a PR with:
@@ -107,9 +113,7 @@ To contribute documentation to HyperBEAM, follow these steps:
        - Any related issues or discussions
      - Screenshots of the rendered documentation (if applicable)
 
-7. **Review Process**
+8. **Review Process**
    - The HyperBEAM team will review your PR
    - Be prepared to make adjustments based on feedback
    - Once approved, your documentation will be merged into the main repository
-
-For more detailed contribution guidelines, see the [Community Guidelines](./docs/misc/community/guidelines.md) and [Development Setup](./docs/misc/community/setup.md) documentation.