/ README.md
README.md
 1  # #B4mad Documentation
 2  
 3  Public documentation for #B4mad Industries' AI agent infrastructure.
 4  
 5  ## Contents
 6  
 7  - [Beads Technical Guide](beads-technical-guide.md) — Multi-agent task coordination architecture using [Beads](https://github.com/steveyegge/beads)
 8  - [Beads Business Value](beads-business-value.md) — Why distributed task tracking matters for AI agent fleets
 9  
10  ## About
11  
12  #B4mad Industries builds decentralized, agent-first infrastructure powered by open source.
13  
14  - **Open Standards** over walled gardens
15  - **Privacy-by-Design** over surveillance capitalism  
16  - **Community** over corporate control
17  
18  Learn more: https://görn.name/
19  
20  ## Containerized Hugo Build Pipeline
21  
22  This project uses a containerized Hugo environment for building and serving the documentation site. This ensures a consistent build environment across development and deployment.
23  
24  ### Prerequisites
25  
26  - [Podman](https://podman.io/) (or Docker, though Podman is preferred)
27  
28  ### Local Development
29  
30  To serve the site locally for development:
31  
32  1.  Navigate to the root of the repository.
33  2.  Run the local server script:
34      ```bash
35      ./scripts/serve.sh
36      ```
37      The site will be available at `http://localhost:1313`.
38  
39  ### Building the Site
40  
41  To build the static site:
42  
43  1.  Navigate to the root of the repository.
44  2.  Run the build script:
45      ```bash
46      ./scripts/build.sh
47      ```
48      The static files will be generated in the `public/` directory.
49  
50      **Base URL Configuration**:
51      The `build.sh` script supports configuring the `baseURL` for Hugo. You can set the `HUGO_BASE_URL` environment variable before running the script. For example:
52      ```bash
53      HUGO_BASE_URL="https://your-domain.com/" ./scripts/build.sh
54      ```
55      If `HUGO_BASE_URL` is not set, the site will be built with relative URLs.
56  
57  ### GitHub Actions Deployment
58  
59  The `.github/workflows/hugo-deploy.yml` workflow automates the build and deployment process to GitHub Pages on every push to the `main` branch.
60  
61  The workflow performs the following steps:
62  1.  Checks out the repository.
63  2.  Sets up Node.js (for potential future use with frontend tooling).
64  3.  Installs Podman.
65  4.  Pulls the `codeberg.org/b4mad/hugo:v1.147.2` container image.
66  5.  Builds the Hugo site using `scripts/build.sh`. The `baseURL` for the GitHub Pages deployment is automatically configured by the workflow.
67  6.  Uploads the built `public/` directory as an artifact.
68  7.  Deploys the artifact to GitHub Pages.
69  
70  This workflow replaces any previous Jekyll-based deployment.