swactor/docs/render_docs.sh
Developer 59845f4059 feat: Docker realization, node binary, docs reorg, and simulation testing
Docker realization (bridging simulation to real TCP):
- NodeDriver (`crates/distribution/src/driver.rs`): bridges DistributedNode
  tick loop to TcpTransport with piggyback-extended wire messages
- swactor-node binary (`crates/node/`): CLI node with --listen, --seed,
  --dashboard-port, --actors flags
- Dockerfile: multi-stage build (rust:1.93-slim → debian:bookworm-slim)
- Docker integration tests (`tests/docker/`): 5-node cluster with 4
  scenarios (convergence, failure detection, actor resolution, rejoin)
- LAN cluster scripts for cross-machine validation
- TCP transport retry-on-stale-connection logic
- /api/distribution REST endpoint on dashboard (feature-gated)
- Piggyback fields (piggyback + from_addr) on Ping/Ack/PingReq messages

Docs reorganization:
- docs/runtime/ — actor-model, runtime, worker-thread, channels
- docs/distribution/ — distribution, swim, kademlia, transport
- docs/diagrams/ — all SVG files
- docs/connectome/ — connectome analysis
- docs/development_history/ — DOCKER_REALIZATION.md, SIMULATION_TESTING.md
- render_docs.sh outputs to docs/diagrams/
- README links updated to new paths

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 07:45:44 +00:00

85 lines
2.3 KiB
Bash
Executable file

#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
DOCS_DIR="$SCRIPT_DIR"
DIAGRAMS_DIR="$DOCS_DIR/diagrams"
TOOLS_DIR="$ROOT_DIR/tools"
mkdir -p "$DIAGRAMS_DIR"
# --- Phase 1: Generate architecture.dot from source AST ---
echo "==> Generating architecture.dot from source..."
cargo run --manifest-path "$TOOLS_DIR/depgraph/Cargo.toml" \
-- --src-dir "$ROOT_DIR/src/" --output architecture --output-dir "$DOCS_DIR/"
# --- Phase 2: Render all .dot files to .svg ---
dots=("$DOCS_DIR"/*.dot)
if [ ${#dots[@]} -eq 0 ]; then
echo "No .dot files found in $DOCS_DIR"
exit 0
fi
render_with_dot() {
for src in "${dots[@]}"; do
name="$(basename "$src" .dot)"
echo " dot: $name.dot -> diagrams/$name.svg"
dot -Tsvg "$src" -o "$DIAGRAMS_DIR/$name.svg"
done
}
render_with_vizjs() {
local tmpfile
tmpfile="$(mktemp "${TMPDIR:-/tmp}/render_docs.XXXXXX.mjs")"
trap 'rm -f "$tmpfile"' RETURN
cat > "$tmpfile" <<NODEJS
import { createRequire } from "module";
import { readFileSync, writeFileSync, readdirSync } from "fs";
import { join, basename } from "path";
const require = createRequire("$TOOLS_DIR/package.json");
const { instance } = require("@viz-js/viz");
const docsDir = "$DOCS_DIR";
const viz = await instance();
const dots = readdirSync(docsDir).filter(f => f.endsWith(".dot"));
for (const file of dots) {
const src = readFileSync(join(docsDir, file), "utf-8");
const name = basename(file, ".dot");
const svg = viz.renderString(src, { format: "svg" });
writeFileSync(join(docsDir, "diagrams", \`\${name}.svg\`), svg);
console.log(\` viz-js: \${file} -> diagrams/\${name}.svg\`);
}
NODEJS
node "$tmpfile"
}
echo "==> Rendering DOT -> SVG..."
if command -v dot &>/dev/null; then
render_with_dot
elif command -v node &>/dev/null; then
if [ -f "$TOOLS_DIR/package.json" ]; then
if ! [ -d "$TOOLS_DIR/node_modules/@viz-js/viz" ]; then
echo "Installing @viz-js/viz..."
(cd "$TOOLS_DIR" && npm install --silent)
fi
else
echo "Error: tools/package.json not found at $TOOLS_DIR" >&2
exit 1
fi
render_with_vizjs
else
echo "Error: No renderer available." >&2
echo "Install graphviz (apt install graphviz) or Node.js." >&2
exit 1
fi
echo "==> Done. SVGs in $DIAGRAMS_DIR/"