mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-07-27 08:45:03 +00:00
docs: Stripe-style 'Browse by product' landing + canonical naming (SQL not DB) (#35)
- services/index.mdx rebuilt as a Stripe-'Browse by product'-style grid: a one-binary hero (One API key. One binary. api.hanzo.ai) + get-started cards, then 10 canonical category sections (AI & Models, Compute, Data, Network, Security & Identity, Observability, Platform, Web3, Apps, Developer Tools), 45 product cards. Names + one-line descriptions are DERIVED from the canonical console product registry (@hanzo/products) so docs align with console + hanzo.ai. All 44 internal links verified to resolve; OSS/standalone forks link out. - Naming fix (per CTO): 'Hanzo DB' -> 'Hanzo SQL'. Renamed services/db.mdx -> services/sql.mdx (git mv, /docs/services/sql), title + body normalized, 0 residual 'Hanzo DB'; meta.json 'db' -> 'sql'. - Removed the duplicate 'Getting Started' (section header + page): the page title is now 'Introduction' under the 'Getting Started' section. Follow-ups (scoped, not in this PR): top-nav header (Fumadocs layout), authoring the ~10 canonical products with no page yet (playground, secrets, projects, ...), per-OSS-fork external doc merges, and de-duping the top-level vs services/ pages. Co-authored-by: Hanzo AI <ai@hanzo.ai>
This commit is contained in:
committed by
GitHub
co-authored by
Hanzo AI
parent
aa7f60aa03
commit
409e60c590
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Getting Started
|
||||
title: Introduction
|
||||
description: Create an account, get an API key, and make your first Hanzo API call in under five minutes.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,147 +1,110 @@
|
||||
---
|
||||
title: Platform
|
||||
description: Hanzo Cloud Platform — 69 unified services for AI, automation, infrastructure, and operations.
|
||||
description: Hanzo Cloud — one Go binary, every service native under one /v1 surface at api.hanzo.ai.
|
||||
index: true
|
||||
icon: Cloud
|
||||
---
|
||||
|
||||
# Hanzo Cloud Platform
|
||||
# Hanzo Cloud
|
||||
|
||||
One API key. One gateway. 69 services. Everything at `api.hanzo.ai`.
|
||||
|
||||
## Core Platform
|
||||
**One API key. One binary. One surface at `api.hanzo.ai`.** Every service below is a native subsystem of the single Hanzo Cloud binary, served under `/v1` and mapped to [hanzoai/openapi](https://github.com/hanzoai/openapi) — no separate gateway or ingress tier to wire up.
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo Cloud" href="/docs/services/cloud">
|
||||
LLM inference gateway — 100+ models from all major providers
|
||||
</Card>
|
||||
<Card title="Hanzo Gateway" href="/docs/services/gateway">
|
||||
Unified API gateway routing to all services at api.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Console" href="/docs/services/console">
|
||||
Developer console — LLM observability, tracing, and prompt management
|
||||
</Card>
|
||||
<Card title="Hanzo Platform" href="/docs/services/platform">
|
||||
PaaS — Git push deploy, databases, containers at platform.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Get started" href="/docs/getting-started">Create an org, get an API key, make your first call.</Card>
|
||||
<Card title="Authentication" href="/docs/authentication">One key for every service — how auth works.</Card>
|
||||
<Card title="API reference" href="/docs/api">The REST surface for every service, generated from OpenAPI.</Card>
|
||||
</Cards>
|
||||
|
||||
# Browse by product
|
||||
|
||||
## AI & Models
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo Chat" href="/docs/services/chat">
|
||||
AI chat interface with multi-model support and MCP tools
|
||||
</Card>
|
||||
<Card title="Hanzo Studio" href="/docs/services/studio">
|
||||
Visual AI workflows (ComfyUI) at studio.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Flow" href="/docs/services/flow">
|
||||
Visual workflow builder for AI and business automation
|
||||
</Card>
|
||||
<Card title="Hanzo Auto" href="/docs/services/auto">
|
||||
Event-driven automation engine at auto.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Models" href="/docs/services/models">
|
||||
Model registry — 376+ models from 58+ providers at models.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Engine" href="/docs/services/engine">
|
||||
GPU inference engine — scheduling, quantization, speculative decoding
|
||||
</Card>
|
||||
<Card title="Hanzo Search" href="/docs/services/search">
|
||||
AI-powered search with generative UI and real-time indexing
|
||||
</Card>
|
||||
<Card title="Hanzo Bot" href="/docs/services/bot">
|
||||
Multi-channel AI assistant with 743+ skills and plugin SDK
|
||||
</Card>
|
||||
<Card title="Hanzo Operative" href="/docs/services/operative">
|
||||
Computer use agent for browser and desktop automation
|
||||
</Card>
|
||||
<Card title="Hanzo Vector" href="/docs/services/vector">
|
||||
Vector database for embeddings, similarity search, and RAG
|
||||
</Card>
|
||||
<Card title="Hanzo ML" href="/docs/services/ml">
|
||||
MLOps pipelines, model registry, and Rust ML toolkit
|
||||
</Card>
|
||||
<Card title="Models" href="/docs/services/models">Browse the live model catalog and configure routing policy.</Card>
|
||||
<Card title="Agents" href="/docs/services/agents">Build, deploy, and run autonomous agents.</Card>
|
||||
<Card title="Inference" href="/docs/llm">Online and batch inference for deployed models.</Card>
|
||||
<Card title="Embeddings" href="/docs/embeddings">Generate, store, and search vector embeddings at scale.</Card>
|
||||
</Cards>
|
||||
|
||||
## Identity & Security
|
||||
## Compute
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo IAM" href="/docs/services/iam">
|
||||
Identity and access management — OIDC, OAuth2, SAML, WebAuthn, FIDO2 at hanzo.id
|
||||
</Card>
|
||||
<Card title="Hanzo KMS" href="/docs/services/kms">
|
||||
Secrets management — TFHE-KMS / MPC-KMS at kms.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo MPC" href="/docs/services/mpc">
|
||||
Multi-party computation for threshold signatures
|
||||
</Card>
|
||||
<Card title="Hanzo Guard" href="/docs/services/guard">
|
||||
AI safety — PII redaction, injection detection, content filtering
|
||||
</Card>
|
||||
<Card title="Hanzo Identity" href="/docs/services/identity">
|
||||
User profiles, directories, and identity resolution
|
||||
</Card>
|
||||
<Card title="Hanzo ZT" href="/docs/services/zt">
|
||||
Zero-trust networking for AI infrastructure
|
||||
</Card>
|
||||
<Card title="GPUs" href="/docs/gpus">GPU clusters, utilization, and cost — on-demand H100/A100.</Card>
|
||||
<Card title="Functions" href="/docs/services/functions">Event-driven serverless functions.</Card>
|
||||
<Card title="Machines" href="/docs/machines">Compute machines and capacity across regions.</Card>
|
||||
<Card title="Edge" href="/docs/services/edge">Compute at the edge, close to your users.</Card>
|
||||
<Card title="Tasks" href="/docs/services/tasks">Durable workflows and schedules.</Card>
|
||||
</Cards>
|
||||
|
||||
## Backend Services
|
||||
## Data
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo Base" href="/docs/services/base">
|
||||
Backend-as-a-service — REST API, auth, realtime, plugins at base.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo ORM" href="/docs/services/orm">
|
||||
Go ORM with SQLite, PostgreSQL, and ZAP drivers
|
||||
</Card>
|
||||
<Card title="Hanzo DB" href="/docs/services/db">
|
||||
Serverless PostgreSQL with pgvector and branching
|
||||
</Card>
|
||||
<Card title="Hanzo KV" href="/docs/services/kv">
|
||||
Redis/Valkey-compatible key-value store and caching
|
||||
</Card>
|
||||
<Card title="Hanzo S3" href="/docs/services/s3">
|
||||
S3-compatible object storage with OIDC SSO
|
||||
</Card>
|
||||
<Card title="Hanzo MQ" href="/docs/services/mq">
|
||||
Job queue and background task processing
|
||||
</Card>
|
||||
<Card title="Hanzo PubSub" href="/docs/services/pubsub">
|
||||
High-performance pub/sub messaging with JetStream
|
||||
</Card>
|
||||
<Card title="Hanzo Edge" href="/docs/services/edge">
|
||||
Edge functions and serverless compute
|
||||
</Card>
|
||||
<Card title="SQL" href="/docs/services/sql">Managed SQL — databases, branches, replicas.</Card>
|
||||
<Card title="KV" href="/docs/services/kv">Managed key-value store — cache & queues.</Card>
|
||||
<Card title="Object Storage" href="/docs/services/s3">S3-compatible object storage — buckets.</Card>
|
||||
<Card title="Vector" href="/docs/services/vector">Managed vector database — embeddings & semantic search.</Card>
|
||||
<Card title="DocDB" href="/docs/docdb">Managed document database.</Card>
|
||||
<Card title="Datastore" href="/docs/datastore">Managed wide-column analytics store.</Card>
|
||||
<Card title="Base" href="/docs/services/base">Multi-tenant Hanzo Base — provision and manage tenants.</Card>
|
||||
<Card title="Memory" href="/docs/memory">Your personal memory — searchable, editable, in one place.</Card>
|
||||
</Cards>
|
||||
|
||||
## Data & Observability
|
||||
## Network
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo Analytics" href="/docs/services/analytics">
|
||||
Web analytics — usage metrics, cost tracking at analytics.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Insights" href="/docs/services/insights">
|
||||
Product analytics — feature flags, experiments at insights.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo O11y" href="/docs/services/o11y">
|
||||
Full-stack observability — metrics, logs, traces at o11y.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Hanzo Status" href="/docs/services/status">
|
||||
White-label status monitoring at status.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Gateway" href="/docs/services/gateway">The unified, gated, priced API gateway — api.hanzo.ai.</Card>
|
||||
<Card title="DNS" href="/docs/services/dns">Managed authoritative DNS.</Card>
|
||||
</Cards>
|
||||
|
||||
## Commerce & Billing
|
||||
## Security & Identity
|
||||
|
||||
<Cards>
|
||||
<Card title="Hanzo Commerce" href="/docs/services/commerce">
|
||||
Headless commerce engine with payments and subscriptions at commerce.hanzo.ai
|
||||
</Card>
|
||||
<Card title="Pricing API" href="/docs/services/pricing">
|
||||
Real-time pricing for models, plans, and compute at pricing.hanzo.ai
|
||||
</Card>
|
||||
<Card title="IAM" href="/docs/services/iam">Organizations, users, and roles (RBAC).</Card>
|
||||
<Card title="KMS" href="/docs/services/kms">Encryption keys and cryptographic operations.</Card>
|
||||
<Card title="MPC" href="/docs/services/mpc">Threshold signing & multi-party computation.</Card>
|
||||
<Card title="Zero Trust" href="/docs/services/zt">Private service access: routers, identities, policies.</Card>
|
||||
<Card title="Authz" href="/docs/authz">Fine-grained authorization policies and checks.</Card>
|
||||
</Cards>
|
||||
|
||||
See the full [API Reference](/docs/openapi) for endpoint-level documentation.
|
||||
## Observability
|
||||
|
||||
<Cards>
|
||||
<Card title="Traces" href="/docs/services/o11y">End-to-end LLM and agent traces.</Card>
|
||||
<Card title="Metrics" href="/docs/metrics">Product metrics, events, and sessions.</Card>
|
||||
<Card title="Logs" href="/docs/logs">Structured logs across all services.</Card>
|
||||
<Card title="Dashboards" href="/docs/dashboards">Product analytics and observability dashboards.</Card>
|
||||
<Card title="Status" href="/docs/services/status">Live health of every Hanzo service.</Card>
|
||||
</Cards>
|
||||
|
||||
## Platform
|
||||
|
||||
<Cards>
|
||||
<Card title="Registry" href="/docs/services/registry">Container images and artifacts — ghcr.io/hanzoai.</Card>
|
||||
<Card title="Pipelines" href="/docs/pipelines">CI/CD pipelines from commit to deploy.</Card>
|
||||
<Card title="PaaS" href="/docs/services/paas">Git-push deploy, databases, and containers.</Card>
|
||||
</Cards>
|
||||
|
||||
## Web3
|
||||
|
||||
<Cards>
|
||||
<Card title="Wallets" href="/docs/services/web3">Connect a wallet and top up cloud credit with HUSD.</Card>
|
||||
<Card title="Referrals" href="/docs/services/referral">Referral link, invite history, and credit earnings.</Card>
|
||||
</Cards>
|
||||
|
||||
## Apps
|
||||
|
||||
<Cards>
|
||||
<Card title="Chat" href="/docs/services/chat">AI chat with Zen models, third-party models, and MCP tools.</Card>
|
||||
<Card title="Bot" href="/docs/services/bot">Agent gateway — channels, skills, OpenAI-compatible API.</Card>
|
||||
<Card title="Search" href="/docs/services/search">Managed search — full-text & hybrid indexes.</Card>
|
||||
<Card title="Studio" href="/docs/services/studio">Build AI apps and pipelines visually.</Card>
|
||||
<Card title="Crawl" href="/docs/crawl">Crawl and extract the web for your agents.</Card>
|
||||
</Cards>
|
||||
|
||||
## Developer Tools
|
||||
|
||||
<Cards>
|
||||
<Card title="CLI ↗" href="https://dev.chat">The hanzo command-line interface.</Card>
|
||||
<Card title="API" href="/docs/api">The REST API reference for every service.</Card>
|
||||
<Card title="Integrations" href="/docs/integrations">Blob storage, Slack, Mixpanel, and Insights connections.</Card>
|
||||
</Cards>
|
||||
|
||||
@@ -48,7 +48,7 @@
|
||||
"cloud",
|
||||
"commerce-events",
|
||||
"dataroom",
|
||||
"db",
|
||||
"sql",
|
||||
"did",
|
||||
"engine",
|
||||
"flow",
|
||||
@@ -70,4 +70,4 @@
|
||||
"visor",
|
||||
"web3"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
title: Hanzo DB
|
||||
title: Hanzo SQL
|
||||
description: Serverless PostgreSQL with pgvector, auto-scaling, instant branching, connection pooling, and point-in-time recovery.
|
||||
---
|
||||
|
||||
# Hanzo DB
|
||||
# Hanzo SQL
|
||||
|
||||
> **API reference** · [Hanzo DB API →](/docs/openapi/db) — every endpoint, generated from the OpenAPI spec.
|
||||
> **API reference** · [Hanzo SQL API →](/docs/openapi/db) — every endpoint, generated from the OpenAPI spec.
|
||||
|
||||
Hanzo DB is a serverless PostgreSQL service purpose-built for AI infrastructure. It provides auto-scaling compute, instant database branching for development workflows, pgvector for embedding storage, connection pooling, automatic backups, and point-in-time recovery -- all managed as part of the Hanzo platform.
|
||||
Hanzo SQL is a serverless PostgreSQL service purpose-built for AI infrastructure. It provides auto-scaling compute, instant database branching for development workflows, pgvector for embedding storage, connection pooling, automatic backups, and point-in-time recovery -- all managed as part of the Hanzo platform.
|
||||
|
||||
**Endpoint:** `db.hanzo.ai`
|
||||
**Gateway:** `api.hanzo.ai/v1/db/*`
|
||||
@@ -113,7 +113,7 @@ async def main():
|
||||
# Insert
|
||||
await conn.execute(
|
||||
"INSERT INTO documents (title, body) VALUES ($1, $2)",
|
||||
"Getting Started", "Welcome to Hanzo DB.",
|
||||
"Getting Started", "Welcome to Hanzo SQL.",
|
||||
)
|
||||
|
||||
# Query
|
||||
@@ -160,7 +160,7 @@ await pool.query(`
|
||||
// Insert
|
||||
await pool.query(
|
||||
'INSERT INTO documents (title, body) VALUES ($1, $2)',
|
||||
['Getting Started', 'Welcome to Hanzo DB.']
|
||||
['Getting Started', 'Welcome to Hanzo SQL.']
|
||||
)
|
||||
|
||||
// Query
|
||||
@@ -203,7 +203,7 @@ curl -H "Authorization: Bearer hk-your-api-key" \
|
||||
|
||||
## pgvector -- Vector Embeddings
|
||||
|
||||
Hanzo DB includes pgvector for storing and querying vector embeddings directly alongside your relational data. No separate vector database required.
|
||||
Hanzo SQL includes pgvector for storing and querying vector embeddings directly alongside your relational data. No separate vector database required.
|
||||
|
||||
### Enable the Extension
|
||||
|
||||
@@ -288,7 +288,7 @@ CREATE INDEX ON embeddings
|
||||
|
||||
## Connection Pooling
|
||||
|
||||
All Hanzo DB endpoints include a built-in PgBouncer connection pooler to efficiently multiplex application connections to PostgreSQL backends.
|
||||
All Hanzo SQL endpoints include a built-in PgBouncer connection pooler to efficiently multiplex application connections to PostgreSQL backends.
|
||||
|
||||
### Pooler Endpoint
|
||||
|
||||
@@ -382,7 +382,7 @@ Branches are near-instant to create regardless of database size because they use
|
||||
|
||||
### Automatic Backups
|
||||
|
||||
Hanzo DB continuously archives WAL (Write-Ahead Log) segments. No cron jobs or manual snapshots required.
|
||||
Hanzo SQL continuously archives WAL (Write-Ahead Log) segments. No cron jobs or manual snapshots required.
|
||||
|
||||
| Setting | Default | Description |
|
||||
|---------|---------|-------------|
|
||||
@@ -457,7 +457,7 @@ These databases are managed by the platform and should not be modified directly.
|
||||
|
||||
### Built-in Metrics
|
||||
|
||||
Hanzo DB exports PostgreSQL metrics to Hanzo Analytics and Prometheus:
|
||||
Hanzo SQL exports PostgreSQL metrics to Hanzo Analytics and Prometheus:
|
||||
|
||||
```sql
|
||||
-- Active connections
|
||||
Reference in New Issue
Block a user