Lux Documentation

Overview

Official Lux Network documentation platform hosted at docs.lux.network. Built as a Turborepo monorepo with 13 independent documentation apps, each powered by Next.js and the @hanzo/docs framework. Covers the full Lux ecosystem: node operation, consensus, SDK usage, contract deployment, subnet/L2 architecture, and every major subsystem (bridge, explorer, wallet, HSM, MPC, bootnode, KMS, indexer, netrunner, CLI).

Repository

Tech Stack

Project Structure

~/work/lux/docs/
  package.json          # Root workspace (lux-docs v0.1.0)
  pnpm-workspace.yaml   # Workspace: apps/*
  turbo.json            # Build/dev/clean/lint/types:check tasks
  Dockerfile            # Multi-stage: node build + nginx serve
  nginx.conf            # Static serving config
  apps/
    docs/               # Main documentation site (port 3000)
    bootnode-docs/       # Bootnode setup and operation
    bridge-docs/         # Cross-chain bridge documentation
    cli-docs/            # Lux CLI reference
    explorer-docs/       # Block explorer documentation
    hsm-docs/            # Hardware Security Module integration
    indexer-docs/        # Chain indexer documentation
    kms-docs/            # Key Management Service
    mpc-docs/            # Multi-Party Computation custody
    netrunner-docs/      # Network testing tool
    sdk-docs/            # Go and JS SDK reference
    wallet-docs/         # Wallet integration guides

Main Docs App (apps/docs/)

Content Structure

Content lives in apps/docs/content/docs/ as MDX files:

Source Configuration

source.config.ts uses @hanzo/docs/mdx/config with:

• Async document loading
• Rehype code plugin with dual themes (github-light / github-dark)
• Languages: ts, js, html, tsx, mdx, go, rust, bash, json, yaml, toml
• Inline code with tailing-curly-colon syntax

Dependencies (apps/docs/package.json)

• @hanzo/docs 16.2.9 (framework)
• @hanzo/docs-core 16.4.3 (core)
• @hanzo/docs-base-ui 16.4.3 (base components)
• @hanzo/docs-ui 16.4.3 (UI components)
• @hanzo/docs-mdx 14.2.5 (MDX processing)
• @hanzo/docs-openapi 10.2.3 (API docs)
• @hanzo/docs-typescript 5.0.1 (TS docs)
• @hanzo/docs-twoslash 3.1.11 (inline eval)
• @hanzo/docs-docgen 3.0.5 (doc generation)
• @hanzo/docs-cli 1.2.5 (CLI tooling)
• Next.js 16, React 19, Tailwind CSS 4

Development

cd ~/work/lux/docs

# Install dependencies
pnpm install

# Start all docs apps in parallel
pnpm dev

# Start main docs only (port 3000)
cd apps/docs && pnpm dev

# Build all apps
pnpm build

# Lint all apps
pnpm lint

# Type check all apps
pnpm types:check

Docker Build

Multi-stage build producing an nginx-served static site:

FROM node:22-alpine AS build
# pnpm install + build (apps/docs)
FROM nginx:alpine
# Copy built output to /usr/share/nginx/html
EXPOSE 3000

Key Patterns

• Each docs app is independent with its own package.json, source.config.ts, and content directory
• All apps share the same @hanzo/docs framework stack
• Build command runs docs-mdx CLI before next build to generate MDX metadata
• Static export (out/ directory) for nginx serving
• Content is MDX with frontmatter, supporting code blocks with syntax highlighting
• Turborepo caches .next/** outputs (excluding .next/cache/**)

Related Repos