Rebased state

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

@@ -0,0 +1,204 @@
+name: 🥘 Build & Deploy Docs HB
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      # Trigger on changes to docs, mkdocs config, or the workflow itself
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/build-deploy-docs.yml"
+  push:
+    branches:
+      - main
+    paths:
+      # Trigger on changes to docs, mkdocs config, or the workflow itself
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/build-deploy-docs.yml"
+
+  # Perform a release using a workflow dispatch
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Run the build as part of PRs to confirm the site properly builds
+  check_build:
+    if: ${{ startsWith(github.ref, 'refs/pull/') }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      # Setup Python environment
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x' # Use a recent Python 3 version
+
+      # Install Erlang OTP 27 using kerl
+      - name: Install Erlang OTP 27
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential autoconf libncurses5-dev libssl-dev
+          git clone https://github.com/kerl/kerl.git
+          ./kerl/kerl build 27.0 otp-27.0
+          ./kerl/kerl install otp-27.0 ~/otp-27.0
+          echo '. ~/otp-27.0/activate' >> ~/.bashrc
+          . ~/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: |
+          sudo apt-get update && sudo apt-get install -y --no-install-recommends \
+            build-essential \
+            cmake \
+            pkg-config \
+            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: |
+          . ~/otp-27.0/activate
+          mkdir -p ~/.config/rebar3
+          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
+        with:
+          node-version: 22 # Or your preferred version
+
+      # 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
+      - 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'
+    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.
+    concurrency:
+      group: deploy
+      cancel-in-progress: false
+    steps:
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      # Setup Python environment
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      # Install Erlang OTP 27 using kerl
+      - name: Install Erlang OTP 27
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential autoconf libncurses5-dev libssl-dev
+          git clone https://github.com/kerl/kerl.git
+          ./kerl/kerl build 27.0 otp-27.0
+          ./kerl/kerl install otp-27.0 ~/otp-27.0
+          echo '. ~/otp-27.0/activate' >> ~/.bashrc
+          . ~/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: |
+          sudo apt-get update && sudo apt-get install -y --no-install-recommends \
+            build-essential \
+            cmake \
+            pkg-config \
+            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: |
+          . ~/otp-27.0/activate
+          mkdir -p ~/.config/rebar3
+          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
+        with:
+          node-version: 22 # Or your preferred version
+
+      - name: 👀 Env
+        run: |
+          echo "Event name: ${{ github.event_name }}"
+          echo "Git ref:    ${{ github.ref }}"
+          echo "GH actor:   ${{ github.actor }}"
+          echo "SHA:        ${{ github.sha }}"
+          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}
+        env:
+          DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
+          ARTIFACTS_OUTPUT_DIR: ${{ steps.build_artifacts.outputs.artifacts_output_dir }}
+          ANT_PROCESS: ${{ secrets.ANT_PROCESS }}

.gitignore

@@ -19,6 +19,7 @@ logs
 *.iml
 rebar3.crashdump
 *~
+/venv
 
 *.json
 !.vscode/*
@@ -40,4 +41,7 @@ cache-*
 
 cu/
 mkdocs-site/
-deployment.sh
+mkdocs-site-id.txt
+mkdocs-site-manifest.csv
+!test/admissible-report-wallet.json
+deployment.sh

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
   "editor.detectIndentation": false,
-  "editor.insertSpaces": false,
+  "editor.insertSpaces": true,
   "editor.tabSize": 4
 }

README.md

@@ -99,7 +99,7 @@ To start a shell with profiles:
 rebar3 as rocksdb shell
 
 # Multiple profiles
-rebar3 as rocksdb,genesis_wasm shell
+rebar3 as rocksdb, genesis_wasm shell
 ```
 
 To create a release with profiles:
@@ -266,42 +266,36 @@ schedule of another execution.
 Details on other devices found in the pre-loaded set can be located in their 
 respective documentation.
 
-## Contributing
+## Documentation
 
-HyperBEAM is developed as an open source implementation of the AO-Core protocol 
-by [Forward Research](https://fwd.arweave.net). Pull Requests are always welcome!
+HyperBEAM uses [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme to build its documentation site. All documentation source files are located in the `docs/` directory.
 
-To get started building on HyperBEAM, check out the [hacking on HyperBEAM](./docs/contribute/setup.md)
-guide.
+To build and view the documentation locally:
 
-## Documentation
+```bash
+# Create and activate a virtual environment (optional but recommended)
+python3 -m venv venv
+source venv/bin/activate  # (macOS/Linux) On Windows use `venv\Scripts\activate`
 
-HyperBEAM uses [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme to build its documentation site.
+# Install required packages
+pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
 
-Building the documentation requires Python 3, pip, and the following packages:
-```bash
-pip3 install mkdocs mkdocs-material
-```
+# Build the docs
+./docs/build-all.sh
 
-- **Source Files:** All documentation source files (Markdown `.md`, images, CSS) are located in the `docs/` directory.
-- **Source Code Docs:** Erlang source code documentation is generated using `rebar3 edoc` (with the `edown_doclet` plugin) into the `docs/source-code-docs/` directory as Markdown files. These are then incorporated into the main MkDocs site.
-- **Build Script:** The entire process (compiling, generating edoc, processing source docs, building the site) is handled by the `./docs/build-all.sh` script.
+# Serve the docs
+cd mkdocs-site
+python3 -m http.server 8000 
+# Then open http://127.0.0.1:8000/ in your browser
+```
 
-To build and view the documentation locally:
+For more details on the documentation structure, how to contribute, and other information, please see the [full documentation README](./docs/README.md).
 
-1.  Ensure you are in the project root directory.
-2.  Run the build script:
-    ```bash
-    ./docs/build-all.sh
-    ```
+## Contributing
 
-This script performs the following steps:
-- Compiles the Erlang project (`rebar3 compile`).
-- Generates Markdown documentation from source code comments (`rebar3 edoc`) into `docs/source-code-docs/`.
-- Processes the generated source code Markdown files (updates index, cleans up TOCs).
-- Builds the MkDocs site into the `dist/mkdocs` directory (`mkdocs build`).
-- Starts a local development server (`mkdocs serve`) to view the site at `http://127.0.0.1:8000/`.
+HyperBEAM is developed as an open source implementation of the AO-Core protocol 
+by [Forward Research](https://fwd.arweave.net). Pull Requests are always welcome!
 
-Press `Ctrl+C` in the terminal where the script is running to stop the local server.
+To get started building on HyperBEAM, check out the [hacking on HyperBEAM](./docs/misc/hacking-on-hyperbeam.md)
+guide.
 
-The final static site is generated in the `dist/mkdocs` directory, as configured in `mkdocs.yml` (`site_dir: dist/mkdocs`).

config.flat

@@ -1 +1 @@
-port: 10001
+port: 10001