mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-24 20:09:02 +00:00
zeekay
4047bbbc36
Fifteen guides became thirty-nine, and every one now opens with the shortest
path from nothing to a working request: mint a key, the first useful call, the
call that makes it useful, then the two or three capabilities to learn first.
Added: netlify render fly heroku · clerk workos okta · supabase firebase
planetscale upstash algolia pinecone · datadog sentry posthog grafana · openai
replicate modal langsmith · stripe temporal vault.
Written one CTO per vendor with an adversarial verifier on each, which is what
caught the defects: fly cited POST on a route the spec serves GET-only;
supabase counted /v1/tasks operations that are all 307 redirects and mapped
match_documents() onto /v1/ai/vectors, which is store CRUD rather than the
query (POST /v1/ai/rag/query); datadog's own table contradicted the example
below it.
Then checked independently rather than trusting the reports: all 238
api.hanzo.ai calls across the guides resolve against openapi.yaml, matching
templated paths so .../projects/acme/apps/web/deploy is recognised as
.../{project}/apps/{app}/deploy. Zero bad paths. Every table well-formed.
The onboarding step mints at POST /v1/account/keys. /v1/keys does not exist —
it is what hanzoai/ci's bin/site prints in its own error message, so anyone
following that hits nothing.
index.mdx and meta.json are written by hand, not by the fleet: 39 agents
contending over two shared files is the one reliable way to corrupt them. Nav,
files and index cross-check at 39 each with no orphan in any direction.
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