lux/docs

mirror of https://github.com/luxfi/docs.git synced 2026-09-24 00:25:32 +00:00

Files

T

zeekay af5f04a630 feat: initialize lux docs site with fumadocs

- Fumadocs-based documentation site
- Uses @luxfi/brand for styling
- Pure black/white minimalist theme

2025-12-14 21:27:13 -08:00

1.4 KiB

Raw Blame History

Lux Network Documentation

Official documentation for Lux Network - Post-quantum secure blockchain infrastructure.

Built with Fumadocs and the Hanzo Docs framework.

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

Part of the Hanzo Docs ecosystem.