mirror of
https://github.com/luxfi/docs.git
synced 2026-09-24 00:25:32 +00:00
zeekayandHanzo Dev
14aa0fb805
Lux is one protocol realised in Go, Rust and C++, and the docs described only
the Go one — so a reader had no way to tell which implementation a statement
was about, or that two of them are measured against the third rather than
against the spec.
Three new pages, one concern each:
/implementations what exists in each language across the six planes
/build native build recipes for all three
/conformance the corpus, the pinned oracle, the harness and its gaps
Refreshed where the existing pages were wrong or ambiguous:
/zap the version word is 2, not 1; the header rules a decoder must
enforce, including the refusals, which are part of the protocol
/zap/family four layers answer to the name ZAP and two of them share no
bytes; naming them apart is the fix, not a version field
/gpu one C++ implementation with bindings, not three; CUDA is not
cleared for anything entering a state root
/nodes a node with no --http-port listens on 9630, not 9650
Every recipe and every port here was run or read out of the source, and the
one failing conformance check is recorded as failing rather than asserted to
be correct.
Co-authored-by: Hanzo Dev <[email protected]>
Lux Network Documentation
Official documentation for Lux Network - Post-quantum secure blockchain infrastructure.
Built with @hanzo/docs - the documentation framework by Hanzo AI.
Getting Started
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build for production
pnpm build
Documentation Structure
content/
└── docs/
├── index.mdx # Welcome page
├── learn/ # Learning resources
│ ├── introduction/ # Introduction to Lux
│ ├── architecture/ # Architecture deep-dive
│ └── consensus/ # Consensus mechanisms
├── build/ # Developer guides
│ ├── quickstart/ # Quick start guide
│ ├── sdk/ # SDK documentation
│ └── contracts/ # Smart contract development
├── nodes/ # Node operation
│ ├── run/ # Running a node
│ ├── validators/ # Validator setup
│ └── staking/ # Staking guide
└── reference/ # API reference
├── api/ # REST/RPC API
└── cli/ # CLI reference
Contributing
- Fork the repository
- Create your feature branch
- Add or modify documentation in
content/docs/ - Submit a pull request
License
MIT © Lux Network
Part of the Hanzo Docs ecosystem.