zeekay 03d35ca787 docs: the links a reader clicks now go somewhere
Probed all 328 clickable external links against a 404 control. The 401s and 405s
are code-sample endpoints answering correctly to an unauthenticated GET; these
were the ones actually broken.

`curl -fsSL https://hanzo.ai/install | sh` — the first thing the CLI page tells
you to run, and it 404s. The installer is served at hanzo.sh, which is what the
landing page and the quickstart already say. Fixed in the generator, so it stays
fixed.

The ZAP bindings pointed at `zap-protocol`, an org whose repos do not exist, and
`@zap-protocol/zap`, a package never published. The org is `zap-proto` and its
repos are named for the language — `go`, `rust`, `py` — not `zap-go`. The Go
import path was wrong with it: proxy.golang.org serves `github.com/zap-proto/go`
and refuses `zap-protocol/zap-go`. 18 files.

Four binding pages listed example files that do not exist in any of those
repositories; they now link to what does. `luxfi/contracts` is private, so both
links 404 for every reader — the prose keeps the contracts and points at docs a
reader can open. `charts.hanzo.ai` does not resolve and `helm repo add` is not
how this estate ships charts: universe installs `oci://oci.hanzo.ai/charts`.
`unpkg.com/@hanzo/ast/browser` needs the file, `dist/browser.js` — unpkg does
not resolve export conditions.
2026-08-24 01:31:00 -07:00
2026-04-17 22:50:22 +08:00
…

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

  1. Clone this repository
  2. Create brand config in packages/brand/src/brands/
  3. Add CSS in packages/brand/css/
  4. Update the brands registry
  5. Set NEXT_PUBLIC_BRAND environment variable

Contributing

Please read the Contributing Guide before submitting a pull request.

License

MIT © Hanzo AI Inc


Built with Hanzo Docs

S
Description
No description provided
Readme MIT
470 MiB
Languages
TypeScript 41.7%
MDX 34.6%
JavaScript 20.5%
CSS 1.3%
XSLT 0.7%
Other 1%