mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-07-27 04:31:57 +00:00
v0.1.0
The API reference asked fonts.scalar.com for 13 webfonts on every load. Our CSP is font-src 'self' data:, so all 13 were blocked — 13 failed requests, 13 console errors, and type that silently fell back to whatever the OS happened to have, on our most public developer-facing page. Naming Geist in a font stack did not fix it: nothing self-hosted it, so @font-face resolved to an empty list and Geist only appeared for people who happened to have it installed. Measuring the live page is what caught that. Now the fonts actually ship: Geist-Variable.woff2 and GeistMono-Variable.woff2 beside the bundle. One VARIABLE file per family covers weights 100-900, so the whole thing is two same-origin requests (~141KB) instead of ten static cuts. Wired through Scalar's own seam — it reads --scalar-font / --scalar-font-code everywhere it sets type, so overriding those two properties beats an !important war against its selectors and survives a bundle upgrade. Deleted the 13 dead @font-face blocks from the vendored bundle rather than leaving them neutered: 15 font declarations where 2 suffice is the same complecting in miniature. Two rules, one place. Verified the bundle still parses and that the reference directory now contains ZERO external hosts.
Hanzo Docs
The documentation framework for Hanzo AI, Lux Network, Zoo Labs Foundation, and Zen LM.
A powerful React.js documentation framework built for the Hanzo ecosystem.
Features
- Multi-Brand Support: Unified framework supporting Hanzo, Lux, Zoo, and Zen documentation
- Next.js 15+: Built on the latest Next.js with App Router
- MDX: Write documentation in MDX with full component support
- Search: Built-in search with Orama and Algolia support
- TypeScript: Full TypeScript support with auto-generated API docs
- OpenAPI: Generate interactive API documentation from OpenAPI specs
- i18n: Internationalization support for multiple languages
- Themes: Customizable themes with dark mode support
Quick Start
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build for production
pnpm build
Project Structure
.
├── apps/
│ ├── docs/ # Main documentation site
│ ├── dev-docs/ # Hanzo Dev CLI docs
│ ├── zen-docs/ # Zen LM model docs (zenlm.org)
│ ├── zap-docs/ # ZAP protocol docs
│ └── bot-docs/ # Bot documentation
├── packages/
│ ├── brand/ # Brand configuration (Hanzo, Lux, Zoo)
│ ├── core/ # Core functionality
│ ├── ui/ # UI components
│ ├── mdx/ # MDX processing
│ ├── openapi/ # OpenAPI integration
│ └── ... # Other packages
└── examples/ # Example implementations
Brand Configuration
Set the brand via environment variable:
# .env.local
NEXT_PUBLIC_BRAND=hanzo # or 'lux', 'zoo', or 'zen'
Available Brands
| Brand | Organization | Documentation |
|---|---|---|
hanzo |
Hanzo AI Inc | hanzoai.github.io/docs |
lux |
Lux Network | docs.lux.network |
zoo |
Zoo Labs Foundation | docs.zoo.ngo |
zen |
Zen LM | zenlm.org |
Development
Prerequisites
- Node.js 18.17+
- pnpm 10+
Commands
# Development
pnpm dev # Start all apps in dev mode
pnpm dev:all # Start docs app only
pnpm dev:examples # Start example apps
# Build
pnpm build # Build all packages
pnpm clean # Clean build artifacts
# Quality
pnpm lint # Run ESLint
pnpm lint:prettier # Check formatting
pnpm prettier # Fix formatting
pnpm test # Run tests
pnpm types:check # Type check
Documentation Sites
Hanzo Docs (hanzoai.github.io/docs)
Documentation for Hanzo AI infrastructure including:
- AI API
- Agent SDK
- MCP Tools
- Chat Platform
- Python/JS SDKs
Lux Docs (docs.lux.network)
Documentation for Lux Network including:
- Architecture & Consensus
- Node Operation
- SDK & CLI
- Smart Contracts
- Post-Quantum Security
Zoo Docs (docs.zoo.ngo)
Documentation for Zoo Labs Foundation including:
- DSO Protocol
- Proof of AI (PoAI)
- Zen Model Family
- Gym SDK
- Training Infrastructure
Forking for New Brands
- Clone this repository
- Create brand config in
packages/brand/src/brands/ - Add CSS in
packages/brand/css/ - Update the brands registry
- Set
NEXT_PUBLIC_BRANDenvironment variable
Contributing
Please read the Contributing Guide before submitting a pull request.
License
MIT © Hanzo AI Inc
Built with Hanzo Docs
Languages
MDX
56%
TypeScript
29.3%
JavaScript
11.4%
Shell
0.9%
CSS
0.7%
Other
1.5%