Files
skills/public/hanzo-docs.html
zeekayandHanzo Dev 9e10c1c10e Each llms index points at the other two
hanzoskills.com/llms.txt now opens with the install line, the API
reference index and the company index, so an agent that lands on any
one of the three can find the rest.

robots.txt claimed 537 documents while llms.txt counts 920. The number
is gone from robots.txt; llms.txt derives it.

public/ is regenerated from scripts/site.py, which it had fallen
behind: the copy-prompt menu and agent bar were in the generator and
not in the committed pages. tests/site.mjs passes against the result.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-11 00:27:59 -07:00

342 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en"><head>
<meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
<title>hanzo-docs</title>
<meta name="color-scheme" content="dark">
<style>
/* Committed to one visual world: a dark instrument panel. No light variant —
the dot field and the hairline rules only read on black, and a naive
inversion would wash both out. Every colour is painted explicitly so the page
never borrows a host background. */
@font-face{font-family:'Zen';src:url('/fonts/Zen-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
@font-face{font-family:'Zen';src:url('/fonts/Zen-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
@font-face{font-family:'Zen Pixel Square';src:url('/fonts/ZenPixel-Square.woff2') format('woff2');font-style:normal;font-display:swap}
:root{
--ink:#f4f4f2; --soft:#9c9c98; --faint:#6a6a66; --ground:#000; --panel:#0a0a0a;
--line:#232323; --line-hi:#3a3a3a; --accent:#f4f4f2;
--font-zen-sans:'Zen',-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif;
--font-zen-mono:'Zen Mono',ui-monospace,"SF Mono",SFMono-Regular,Menlo,Consolas,monospace;
--font-zen-pixel-square:'Zen Pixel Square',monospace;
--mono:var(--font-zen-mono);
--sans:var(--font-zen-sans);
/* Controls are pills and surfaces are soft, as on hanzo.ai. */
--r:999px; --r-soft:14px;
}
*{box-sizing:border-box}
html{-webkit-text-size-adjust:100%}
body{margin:0;background:var(--ground);color:var(--ink);font-family:var(--sans);
font-size:16px;line-height:1.65;-webkit-font-smoothing:antialiased}
.wrap{max-width:60rem;margin:0 auto;padding:0 1.75rem}
/* The dot field. A halftone made of one repeating radial-gradient, faded out
along the diagonal by a mask so it reads as a wave rather than wallpaper. */
/* No overflow clip here: the dot field is inset to the box already, and a clip
would cut off the copy-prompt menu. */
.hero{position:relative;border-bottom:1px solid var(--line)}
.hero::before{content:"";position:absolute;inset:0;
background-image:radial-gradient(var(--line-hi) 1px, transparent 1px);
background-size:7px 7px;
-webkit-mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
pointer-events:none}
.hero .wrap{position:relative;padding-top:5.5rem;padding-bottom:4rem}
nav{border-bottom:1px solid var(--line)}
nav .in{max-width:60rem;margin:0 auto;padding:1.1rem 1.75rem;display:flex;
justify-content:space-between;align-items:center;gap:1rem}
.brand{font-family:var(--mono);font-size:.85rem;letter-spacing:.14em;
text-transform:uppercase;color:var(--ink);text-decoration:none;
display:inline-flex;align-items:center;gap:.6rem}
.brand i{font-style:normal;color:var(--faint)}
.mark{width:1.15em;height:1.15em;display:block;flex:0 0 auto}
nav a.up{font-family:var(--mono);font-size:.72rem;letter-spacing:.14em;
text-transform:uppercase;color:var(--soft);text-decoration:none}
nav a.up:hover{color:var(--ink)}
h1{font-family:var(--mono);font-size:clamp(2rem,5.4vw,3.4rem);line-height:1.12;
letter-spacing:-.02em;margin:0 0 1.1rem;font-weight:500;text-wrap:balance}
h1 em{font-style:normal;color:var(--faint)}
.lede{color:var(--soft);font-size:1.05rem;max-width:52ch;margin:0 0 2.25rem}
.btns{display:flex;flex-wrap:wrap;gap:.7rem;margin:0 0 .5rem;align-items:center}
.btn{display:inline-flex;align-items:center;gap:.5rem;font-family:var(--mono);
font-size:.72rem;letter-spacing:.14em;text-transform:uppercase;
padding:.8rem 1.4rem;border:1px solid var(--line-hi);border-radius:var(--r);
color:var(--ink);text-decoration:none;background:transparent;cursor:pointer;
line-height:1.2;font-weight:400}
.btn:hover{background:#141414;text-decoration:none;border-color:var(--soft)}
.btn.solid{background:var(--ink);color:#000;border-color:var(--ink)}
.btn.solid:hover{background:#d8d8d4}
.btn .chev{width:.7em;height:.7em;flex:0 0 auto;transition:transform .15s ease}
.btn[aria-expanded="true"] .chev{transform:rotate(180deg)}
/* Copy-prompt selector. Each row copies the prompt for its own target. */
.copy{position:relative;display:inline-flex}
.menu{position:absolute;top:calc(100% + .5rem);left:0;z-index:20;min-width:21rem;
background:var(--panel);border:1px solid var(--line-hi);border-radius:var(--r-soft);
padding:.4rem;display:flex;flex-direction:column;
box-shadow:0 12px 32px rgba(0,0,0,.75)}
.menu[hidden]{display:none}
.mi{display:flex;align-items:center;gap:.7rem;width:100%;text-align:left;
padding:.62rem .8rem;border:0;border-radius:calc(var(--r-soft) - .35rem);
background:transparent;color:var(--ink);font-family:var(--mono);font-size:.76rem;
letter-spacing:.04em;text-decoration:none;cursor:pointer;line-height:1.3;
white-space:nowrap}
.mi:hover,.mi:focus-visible{background:#181818;outline:none}
.mi .mark{width:1.05rem;height:1.05rem;color:var(--soft)}
.mi:hover .mark{color:var(--ink)}
.mi u{margin-left:auto;color:var(--faint);text-decoration:none;font-size:.68rem;
letter-spacing:.1em;text-transform:uppercase}
/* Works-with bar: one scrolling row, name and mark per agent. */
.strip{border-bottom:1px solid var(--line);background:var(--panel)}
.strip .in{max-width:60rem;margin:0 auto;padding:.9rem 1.75rem;display:flex;
align-items:center;gap:1.25rem;font-family:var(--mono);font-size:.72rem;
letter-spacing:.1em;text-transform:uppercase;color:var(--faint)}
.strip b{color:var(--soft);font-weight:400;flex:0 0 auto;
border-right:1px solid var(--line);padding-right:1.25rem;align-self:stretch;
display:flex;align-items:center}
.bar{display:flex;align-items:center;gap:.5rem;flex:1 1 auto;min-width:0;
overflow-x:auto;scrollbar-width:none;scroll-snap-type:x proximity;
-webkit-overflow-scrolling:touch;
-webkit-mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent);
mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent)}
.bar::-webkit-scrollbar{display:none}
.agent{display:inline-flex;align-items:center;gap:.45rem;flex:0 0 auto;
padding:.4rem .85rem;border:1px solid var(--line);border-radius:var(--r);
color:var(--soft);white-space:nowrap;scroll-snap-align:start;
text-decoration:none;background:var(--ground)}
.agent:hover{color:var(--ink);border-color:var(--line-hi);text-decoration:none}
.agent .mark{width:.95rem;height:.95rem}
h2{font-family:var(--mono);font-size:1.1rem;letter-spacing:-.01em;margin:2.75rem 0 .75rem;font-weight:500}
h3{font-size:1rem;margin:2rem 0 .5rem;font-weight:600}
h4,h5,h6{font-size:.94rem;margin:1.5rem 0 .5rem;font-weight:600}
p{margin:0 0 1rem;max-width:70ch}
ul,ol{margin:0 0 1rem;padding-left:1.35rem;max-width:70ch}
li{margin:.22rem 0}
a{color:var(--ink);text-decoration:underline;text-underline-offset:3px;
text-decoration-color:var(--line-hi)}
a:hover{text-decoration-color:var(--ink)}
a:focus-visible{outline:1px solid var(--ink);outline-offset:3px}
code{font-family:var(--mono);font-size:.85em;background:var(--panel);
border:1px solid var(--line);border-radius:5px;padding:.1em .36em}
pre{background:var(--panel);border:1px solid var(--line);padding:1rem 1.1rem;
border-radius:var(--r-soft);overflow-x:auto;margin:0 0 1.25rem}
pre code{background:none;border:0;padding:0;font-size:.82rem;line-height:1.7}
blockquote{margin:0 0 1rem;padding-left:1rem;border-left:1px solid var(--line-hi);color:var(--soft)}
hr{border:0;border-top:1px solid var(--line);margin:2.5rem 0}
table{border-collapse:collapse;width:100%;margin:0 0 1.25rem;font-size:.92rem;
display:block;overflow-x:auto}
th,td{border:1px solid var(--line);padding:.5rem .7rem;text-align:left}
.curl{display:block;background:var(--panel);border:1px solid var(--line);
border-radius:var(--r-soft);padding:.95rem 1.1rem;font-family:var(--mono);
font-size:.8rem;color:var(--soft);overflow-x:auto;margin:0 0 2.5rem;
white-space:pre;line-height:1.9}
.curl b{color:var(--ink);font-weight:400}
.curl i{font-style:normal;color:var(--faint)}
/* index */
#q{width:100%;padding:.85rem 1.2rem;font-family:var(--mono);font-size:.85rem;color:var(--ink);
background:var(--panel);border:1px solid var(--line);border-radius:var(--r);margin:0 0 .6rem}
#q::placeholder{color:var(--faint);text-transform:uppercase;letter-spacing:.1em;font-size:.72rem}
#q:focus{outline:none;border-color:var(--soft)}
#count{color:var(--faint);font-family:var(--mono);font-size:.72rem;letter-spacing:.1em;
text-transform:uppercase;margin:0 0 2rem}
.cat{margin:2.5rem 0 .5rem;font-family:var(--mono);font-size:.7rem;letter-spacing:.16em;
text-transform:uppercase;color:var(--faint);border-bottom:1px solid var(--line);
padding-bottom:.45rem}
.row{display:block;padding:.6rem .9rem;margin:0 -.9rem;border-bottom:1px solid var(--line);
border-radius:var(--r-soft);text-decoration:none}
.row:hover{background:#0a0a0a}
.nm{font-family:var(--mono);font-size:.84rem;color:var(--ink);display:block}
.ds{color:var(--soft);font-size:.9rem;display:block;margin-top:.12rem}
footer{margin-top:4rem;padding:2rem 0 4rem;border-top:1px solid var(--line);
color:var(--faint);font-size:.85rem}
footer a{color:var(--soft)}
.fmap{display:grid;gap:1.75rem;grid-template-columns:repeat(auto-fit,minmax(11rem,1fr));
margin:0 0 2rem;font-size:.85rem}
.fmap b{display:block;font-family:var(--mono);font-size:.68rem;letter-spacing:.16em;
text-transform:uppercase;color:var(--faint);font-weight:400;margin:0 0 .6rem;
border-bottom:1px solid var(--line);padding-bottom:.4rem}
.fmap a{display:inline-block;color:var(--ink);text-decoration:none;margin:.3rem .35rem 0 0}
.fmap a:hover{text-decoration:underline}
.fmap div{color:var(--faint);line-height:1.5}
.fend{border-top:1px solid var(--line);padding-top:1.25rem;font-size:.82rem}
@media (max-width:640px){
.hero .wrap{padding-top:3.25rem;padding-bottom:2.75rem}
.btns{gap:.5rem}
.btn{padding:.75rem 1.15rem;font-size:.68rem}
.copy,.copy .btn{width:100%;justify-content:center}
.menu{left:0;right:0;min-width:0}
.strip .in{flex-direction:column;align-items:flex-start;gap:.6rem;padding:.9rem 1.75rem}
.strip b{border-right:0;padding-right:0}
.bar{width:100%}
}
</style>
<link rel="alternate" type="text/markdown" href="/hanzo-docs.md">
<link rel="icon" href="/favicon.svg">
<link rel="canonical" href="https://hanzoskills.com/hanzo-docs">
</head>
<!-- Reading this with a machine? Every page here is also plain markdown.
This one: https://hanzoskills.com/hanzo-docs.md
Index: https://hanzoskills.com/llms.txt
Corpus: https://hanzoskills.com/all.md
Append .md to any path for the markdown twin. -->
<body>
<nav><div class="in">
<a class="brand" href="/"><svg class="mark" viewBox="0 0 67 67" fill="currentColor" aria-hidden="true"><path d="M22.21 67V44.6369H0V67H22.21Z"/><path d="M66.7038 22.3184H22.2534L0.0878906 44.6367H44.4634L66.7038 22.3184Z"/><path d="M22.21 0H0V22.3184H22.21V0Z"/><path d="M66.7198 0H44.5098V22.3184H66.7198V0Z"/><path d="M66.7198 67V44.6369H44.5098V67H66.7198Z"/></svg> HANZO<i>SKILLS</i></a>
<a class="up" href="/">All skills</a>
</div></nav>
<div class="wrap">
<h1>hanzo-docs</h1><p class="lede">Hanzo Docs is a multi-brand documentation platform — fork of fumadocs with 27 packages and 15 apps.</p><h1>Hanzo Docs - Multi-Brand Documentation Platform</h1>
<p><strong>Category</strong>: Hanzo Ecosystem <strong>Related Skills</strong>: <code>hanzo/hanzo-cloud.md</code>, <code>hanzo/python-sdk.md</code>, <code>hanzo/hanzo-brand.md</code></p>
<h2>Overview</h2>
<p>Hanzo Docs is a <strong>multi-brand documentation platform</strong> — fork of fumadocs with 27 packages and 15 apps. Serves documentation for Hanzo, Lux, Zoo, and Zen brands from a single monorepo with shared components and per-brand theming.</p>
<p><strong>NOTE</strong>: This is a <strong>fumadocs fork</strong> (not a plain Next.js MDX site). It&#x27;s a monorepo with <strong>27 packages</strong> and <strong>15 apps</strong>, supporting multi-brand documentation (hanzo.ai/docs, docs.lux.network, docs.zoo.ngo, docs.zenlm.org).</p>
<h3>Why Hanzo Docs?</h3>
<ul><li><strong>fumadocs fork</strong>: Full-featured documentation framework</li><li><strong>Multi-brand</strong>: 4 brands from one codebase (Hanzo, Lux, Zoo, Zen)</li><li><strong>27 packages</strong>: Shared components, MDX plugins, search, themes</li><li><strong>15 apps</strong>: Brand-specific documentation sites</li><li><strong>MDX-powered</strong>: Markdown with React components (live code, diagrams)</li><li><strong>Auto-generated API docs</strong>: From OpenAPI spec</li><li><strong>Full-text search</strong>: Across all documentation sites</li><li><strong>Versioned</strong>: Documentation tied to SDK versions</li></ul>
<h2>When to use</h2>
<ul><li>Writing or updating documentation for any Hanzo brand</li><li>Adding API reference pages</li><li>Creating tutorials or guides</li><li>Modifying the documentation platform itself</li><li>Adding a new brand/product documentation site</li></ul>
<h2>Quick reference</h2>
<p>| Item | Value | |------|-------| | Repo | <code>github.com/hanzoai/docs</code> | | Upstream | fumadocs fork | | Framework | Next.js 14+ with MDX | | Packages | 27 | | Apps | 15 | | Dev | <code>pnpm dev</code> | | Build | <code>pnpm build</code> | | Port | 3000 (dev) |</p>
<h2>Brand Sites</h2>
<p>| Brand | URL | App | |-------|-----|-----| | Hanzo | <code>hanzo.ai/docs</code> | <code>apps/hanzo/</code> | | Lux | <code>docs.lux.network</code> | <code>apps/lux/</code> | | Zoo | <code>docs.zoo.ngo</code> | <code>apps/zoo/</code> | | Zen | <code>docs.zenlm.org</code> | <code>apps/zen/</code> |</p>
<h2>Project Structure</h2>
<pre><code>docs/
├── apps/ # 15 brand-specific apps
│ ├── hanzo/ # hanzo.ai/docs
│ ├── lux/ # docs.lux.network
│ ├── zoo/ # docs.zoo.ngo
│ ├── zen/ # docs.zenlm.org
│ └── ... # Other product-specific doc sites
│ # Apps: base-docs, bootnode-docs, bot-docs, cloud,
│ # dev-docs, dns-docs, docs, flow, insights-docs,
│ # platform, team, visor, zap-docs, zen-docs, zt-docs
├── packages/ # 27 shared packages
│ ├── core/ # Core fumadocs engine
│ ├── mdx/ # MDX processing and plugins
│ ├── ui/ # Shared UI components
│ ├── search/ # Full-text search
│ ├── openapi/ # OpenAPI → docs generator
│ ├── components/ # Shared MDX components
│ │ ├── CodeBlock.tsx
│ │ ├── ApiEndpoint.tsx
│ │ ├── Callout.tsx
│ │ └── SDKTabs.tsx
│ └── ... # More packages
├── content/ # Shared content
│ ├── api/ # API reference (auto-generated from OpenAPI)
│ ├── guides/ # Cross-brand guides
│ └── sdks/ # SDK documentation
├── pnpm-workspace.yaml
└── package.json</code></pre>
<h2>Development</h2>
<pre><code class="lang-bash">git clone https://github.com/hanzoai/docs.git
cd docs
pnpm install
# Dev all brands
pnpm dev
# Dev specific brand
pnpm dev --filter @hanzo/docs-hanzo
# Build for production
pnpm build
# Lint MDX
pnpm lint
# Check broken links
pnpm check-links</code></pre>
<h2>Writing Documentation</h2>
<h3>MDX Page</h3>
<pre><code class="lang-mdx">---
title: &quot;Chat Completions&quot;
description: &quot;Create chat completions with the Hanzo API&quot;
---
import { CodeBlock, ApiEndpoint, Callout, SDKTabs } from &quot;@hanzo/docs-components&quot;
# Chat Completions
&lt;Callout type=&quot;info&quot;&gt;
This endpoint is OpenAI-compatible.
&lt;/Callout&gt;
&lt;ApiEndpoint method=&quot;POST&quot; path=&quot;/v1/chat/completions&quot; /&gt;
## Request
&lt;SDKTabs&gt;
&lt;SDKTabs.Tab lang=&quot;python&quot; title=&quot;Python&quot;&gt;
{`from hanzoai import Hanzo
client = Hanzo()
response = client.chat.completions.create(
model=&quot;zen-70b&quot;,
messages=[{&quot;role&quot;: &quot;user&quot;, &quot;content&quot;: &quot;Hello&quot;}],
)`}
&lt;/SDKTabs.Tab&gt;
&lt;SDKTabs.Tab lang=&quot;typescript&quot; title=&quot;TypeScript&quot;&gt;
{`import Hanzo from &quot;hanzoai&quot;
const client = new Hanzo()
const response = await client.chat.completions.create({
model: &quot;zen-70b&quot;,
messages: [{ role: &quot;user&quot;, content: &quot;Hello&quot; }],
})`}
&lt;/SDKTabs.Tab&gt;
&lt;/SDKTabs&gt;</code></pre>
<h3>Adding a New Brand</h3>
<pre><code class="lang-bash"># 1. Create new app
cp -r apps/hanzo apps/new-brand
# 2. Configure brand colors, logo, navigation in the app
# 3. Add to pnpm-workspace.yaml
# 4. Add to CI/CD</code></pre>
<h2>Redirects</h2>
<p>Service-specific docs have vanity URLs:</p>
<ul><li><code>orm.hanzo.ai</code> → <code>hanzo.ai/docs/services/orm</code></li><li><code>hanzo.ai/docs/api</code> → Full API reference</li><li><code>hanzo.ai/docs/sdks/python</code> → Python SDK guide</li></ul>
<h2>Known-issue: <code>@hanzo/docs</code> workspace-protocol leak</h2>
<p><code>@hanzo/[email protected]</code> and sibling <code>16.7.5</code> packages were published with unresolved <code>workspace:*</code> deps — including <code>@hanzo/docs-tailwind</code> which was never published to npm. Downstream consumers see install failures.</p>
<p><strong>Workarounds for consumers</strong>:</p>
<ol><li>Vendor <code>~/work/hanzo/docs/packages/*</code> into a <code>vendor/hanzo-docs/</code></li></ol>
<p> directory and wire a <code>pnpm-workspace.yaml</code> so <code>workspace:*</code> resolves locally. A <code>.pnpmfile.cjs</code> can strip workspace refs to packages not vendored (build-only tooling).</p>
<ol><li>Pin to a known-clean version pair (<code>@hanzo/[email protected]</code> +</li></ol>
<p> <code>@hanzo/[email protected]</code>) — see <code>~/work/zap/zap-protocol.github.io/</code> for a reference setup.</p>
<p><strong>Upstream fix</strong>: add a <code>prepublishOnly</code> hook that rewrites <code>workspace:*</code> → concrete versions, or publish the missing packages.</p>
<p><strong>API renames</strong> between docs versions:</p>
<ul><li><code>app/layout.tsx</code>: <code>@hanzo/docs/ui/provider/next</code> (missing in published</li></ul>
<p> umbrella) → use <code>@hanzo/docs-core/framework/next</code> × <code>@hanzo/docs/ui/provider/base</code></p>
<ul><li><code>lib/source.ts</code>: <code>docs.toFumadocsSource()</code> → <code>docs.toSource()</code></li></ul>
<h2>Related Skills</h2>
<ul><li><code>hanzo/python-sdk.md</code> - Python SDK (documented here)</li><li><code>hanzo/js-sdk.md</code> - JS SDK (documented here)</li><li><code>hanzo/hanzo-brand.md</code> - Brand guidelines for docs styling</li><li><code>hanzo/hanzo-cloud.md</code> - Cloud dashboard (links to docs)</li></ul>
<hr>
<p><strong>Last Updated</strong>: 2026-05-12 <strong>Category</strong>: Hanzo Ecosystem <strong>Related</strong>: documentation, fumadocs, mdx, nextjs, multi-brand <strong>Prerequisites</strong>: MDX, Next.js basics</p>
<footer>
<div class="fmap">
<div><b>Build</b>
<a href="https://hanzo.app">hanzo.app</a> app builder
<a href="https://hanzo.codes">hanzo.codes</a> code with an agent
<a href="https://hanzoskills.com">hanzoskills.com</a> what an agent reads</div>
<div><b>Run</b>
<a href="https://console.hanzo.ai">console.hanzo.ai</a> cloud console
<a href="https://api.hanzo.ai">api.hanzo.ai</a> the API</div>
<div><b>Account</b>
<a href="https://hanzo.id">hanzo.id</a> sign in
<a href="https://pay.hanzo.ai">pay.hanzo.ai</a> top up
<a href="https://billing.hanzo.ai">billing.hanzo.ai</a> invoices and usage</div>
<div><b>Company</b>
<a href="https://hanzo.ai">hanzo.ai</a> canonical
<a href="https://hanzo.ventures">hanzo.ventures</a> ventures</div>
</div>
<div class="fend"><a href="/hanzo-docs.md">This page as plain text</a> · <a href="/llms.txt">Index for agents</a></div>
</footer>
</div></body></html>