mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-24 20:09:02 +00:00
zooqueen
47ec199510
The two UI packages are adapters over different headless primitive libraries: base-ui wraps @base-ui/react, radix-ui wraps @radix-ui/*. They are meant to be alternatives. Every app here had been pulling from both. Each package builds its own React contexts, so a provider from one is invisible to a consumer from the other. insights-docs, pulsar-docs and zen-docs mounted RootProvider and the CSS preset from base-ui but took DocsLayout and the MDX map from radix-ui, so the layout's search trigger read radix's SearchContext default -- enabled:false, setOpenSearch a no-op. Search was dead on those three sites and nothing said so. apps/docs was consistent in its app code (layout, provider, MDX map, CSS all base-ui) but 28 hand-written MDX pages and the two resolveAlias entries reached for radix Callout, Card, Files and Tabs, which loaded the whole second library alongside the first. Tabs was the visible cost: the nested-tabs check compares against the context of its own copy, so a radix Tab inside a base-ui Tabs could not see its parent and drew a second frame. Every generated page already imported base-ui tabs. Callout, Card and Files are byte-identical across the two packages, so this moves no pixels; Tabs gains the nesting the rest of the site has. Nothing in apps/ imports docs-ui now, and its dependency entry goes with it. The registry generator still names both -- it publishes both.
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