mirror of
https://github.com/luxfi/consensus.git
synced 2026-09-24 00:26:58 +00:00
- Create proper homepage for static export - Add meta refresh to auto-redirect to documentation - Includes fallback link for manual navigation This fixes the 404 error on the root path.
Lux Consensus Documentation
Beautiful documentation site built with Fumadocs and @hanzo/ui.
Development
cd docs
pnpm install
pnpm dev
Visit http://localhost:3001
Build
pnpm build
pnpm start
Features
- 🌑 Dark Mode First: Beautiful dark theme by default
- ⚡ Fast: Built on Next.js 16 with RSC
- 🎨 @hanzo/ui: Uses Hanzo AI design system
- 📚 Fumadocs: Powerful MDX documentation framework
- 🔍 Search: Built-in search functionality
- 📱 Responsive: Mobile-friendly design
- 🎯 Type-safe: Full TypeScript support
Structure
docs/
├── app/ # Next.js app directory
│ ├── docs/ # Documentation pages
│ ├── layout.tsx # Root layout
│ └── global.css # Global styles
├── content/ # MDX documentation
│ └── docs/
│ ├── index.mdx # Homepage
│ ├── sdk/ # SDK documentation
│ │ ├── go.mdx
│ │ ├── c.mdx
│ │ ├── rust.mdx
│ │ ├── python.mdx
│ │ └── cpp.mdx
│ └── benchmarks.mdx # Performance benchmarks
├── components/ # React components
├── source.config.ts # Fumadocs configuration
├── tailwind.config.ts # Tailwind CSS config
└── package.json # Dependencies
Adding Documentation
- Create a new
.mdxfile incontent/docs/ - Add frontmatter:
---
title: Your Page Title
description: Brief description
---
# Content goes here...
- The page will automatically appear in the sidebar
SDK Documentation
Each language SDK has its own documentation page:
- Go: Complete API reference with examples
- C: Native C API for embedded systems
- Rust: Safe Rust bindings
- Python: Pythonic API for research
- C++: GPU-accelerated with MLX
Benchmarks
Real benchmark results from:
- Apple M1 Max
- Go 1.24.5
- Latest C, Rust, Python implementations
Updated automatically from ../benchmarks/results/.
Deployment
Deploy to Vercel, Netlify, or any static hosting:
pnpm build
# Output in .next/
License
Copyright (C) 2025, Lux Industries Inc. All rights reserved.