Xudanu Documentation

Everything you need to understand, run, and extend the Udanax Gold hypertext engine.

Getting Started START HERE

README

Quick Start guide, prerequisites, CLI reference, security notes, and macOS Gatekeeper instructions.

markdown

User Manual

Complete manual covering server setup, web UI guide, command bar, document operations, and troubleshooting.

markdown

TLS Setup Guide

Configure HTTPS and WSS for encrypted connections. Self-signed certs, Caddy reverse proxy, and Safari compatibility.

markdown

Test Registry

How to run the 1,664 tests (unit, integration, TLS, proptest). Stress testing and coverage expectations.

markdown

Technical Architecture

15-section deep dive with 9 SVG diagrams, worked examples, and Big-O analysis of every data structure.

9 diagrams · interactive

Content + Performance

How O-tree, H-tree, and Canopy combine for O(log n) transclusion queries. Visual layer-by-layer walkthrough.

interactive diagram

30 Years of Innovation

Presentation: Xanadu history, migration story, architecture, performance, and live demo. Arrow keys to navigate.

10 slides

Architecture & Design DEEP DIVES

System Overview

Xanadu Gold as a Rust library compiling to WebAssembly. High-level component map and design philosophy.

markdown

Three-Layer Architecture

Separation of the core hypertext engine from the applications and clients built on top of it.

markdown

Content Model

The Udanax Gold content model where content is identity — bytes are their own addressing key.

markdown

The 17 Rules of Xanadu

Nelson's original 17 rules for Xanadu systems with xudanu's compliance status for each rule.

markdown

Rule 8: Publication Model

How Xudanu's publication model compares to the original Udanax Gold and Nelson's specifications.

markdown

Migration Notes

Tracking the port from Udanax Gold C++ to Rust. Edition, XnRegion, RangeElement, and connected components.

markdown

Protocol & Integration FOR DEVELOPERS

API Reference

Wire protocol API reference (v2). WebSocket JSON message format, all operations, request/response schemas.

markdown

Protocol & Audit

WebSocket protocol details, session lifecycle, and server-side audit/logging capabilities.

markdown

Integration Guide

How to integrate Xanadu Gold into a JavaScript or TypeScript application.

markdown

Custom Frontend Guide

Building custom frontends that connect to the xudanu server over its WebSocket JSON API.

markdown

Micropayments & Cost Model

Ted Nelson's micropayment vision, storage cost accounting, the utility meter, and per-use billing.

markdown

Paths, Snapshots, Endorsements

Label sequences through nested editions, snapshot persistence, and the endorsement system.

markdown

Transclusion Plan

Plan for connecting BackfollowEngine, canopy, recorder, and ENT into a working transclusion detection pipeline.

markdown

Implementation Phases BUILD LOG

Design documents for each phase of the Rust implementation, from core data structures through federation.

Phases 4–6: Mapping, FeText, Wrappers, Clubs

Mapping algebra, text manipulation, type wrappers with certification, and the club-based permission hierarchy.

phase

Phase 7: Label & Identity Unification

Label system and identity unification — two critical features from the Udanax Gold model.

phase

Phase 8: Bundle Retrieval & Storage Cost

Reading content from the document store and storage cost accounting for editions.

phase

Phase 9: Shared Content Mapping

Content-fingerprint-based shared detection and proper mapping types beyond positional matching.

phase

Phase 10: Full Transclusion Queries

Range-based transclusion queries and an ordered bundle stepper with merge-sort for the O-tree.

phase

Phase 11: Recorder, Fossil, Agenda

Persistent queries that accumulate results over time, plus admin health monitoring.

phase

Phase 12: Modern Encryption

Production-grade cryptography: Ed25519, X25519, ChaCha20-Poly1305, HKDF-SHA256, Argon2id.

phase

Phase 13: Endorsement Authority

Endorsement system wired into the server API with authority validation.

phase

Phase 14: Federation Foundation

Types, identity, and addressing for multi-server federation.

phase

Phase 15: Server-to-Server Transport

Mutual authentication and encrypted channels between federated servers.

phase

Phase 16: Content Replication

G-Set CRDT with BLAKE3 verification for cross-server content replication.

phase

Phase 18: DagWood Reconciliation

The Reconciliation Plane — mutable state via DagWood for concurrent edit resolution.

phase

Phase 19a: Trust & Membership

Web-of-trust join protocol and membership management for federated servers.

phase

Phase 19b: Governance (PBFT)

Governance Plane using lightweight PBFT consensus for federation-wide decisions.

phase