mirror of
https://github.com/luxfi/docs.git
synced 2026-09-24 00:25:32 +00:00
zeekay
8446558013
Single-app → multi-app monorepo architecture: - apps/docs/ — Main Lux docs (replaces root-level app) - apps/bootnode-docs/ — Bootnode service - apps/bridge-docs/ — Bridge service - apps/cli-docs/ — CLI tool - apps/explorer-docs/ — Block explorer - apps/hsm-docs/ — Hardware security module - apps/indexer-docs/ — Blockchain indexer - apps/kms-docs/ — Key management service - apps/mpc-docs/ — Multi-party computation - apps/netrunner-docs/ — Network testing - apps/sdk-docs/ — SDK documentation - apps/wallet-docs/ — Wallet service New: pnpm-workspace.yaml, turbo.json, per-app configs Updated: Dockerfile (filter build), .gitignore (.turbo/, .docs/) Root package.json stripped to workspace orchestrator
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.