mirror of
https://github.com/luxfi/docs.git
synced 2026-09-24 00:25:32 +00:00
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
# Lux Network Documentation
|
|
|
|
Official documentation for Lux Network - Post-quantum secure blockchain infrastructure.
|
|
|
|
Built with [@hanzo/docs](https://hanzo.ai/docs) - the documentation framework by Hanzo AI.
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
# 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
|
|
|
|
1. Fork the repository
|
|
2. Create your feature branch
|
|
3. Add or modify documentation in `content/docs/`
|
|
4. Submit a pull request
|
|
|
|
## License
|
|
|
|
MIT © Lux Network
|
|
|
|
---
|
|
|
|
Part of the Hanzo Docs ecosystem.
|