2026-05-15 03:45:22 +03:00
|
|
|
# User Docs
|
|
|
|
|
|
|
|
|
|
**Audience:** users, CLI users, HTTP clients, and self-hosting operators
|
|
|
|
|
|
|
|
|
|
This is the public-facing entry point. These docs should describe behavior,
|
|
|
|
|
commands, configuration, and operational contracts without requiring knowledge
|
|
|
|
|
of MRs, internal recovery mechanics, or contributor-only invariants.
|
|
|
|
|
|
|
|
|
|
## Start Here
|
|
|
|
|
|
|
|
|
|
| Goal | Read |
|
|
|
|
|
|---|---|
|
|
|
|
|
| Install OmniGraph | [install.md](install.md) |
|
|
|
|
|
| Run the CLI locally | [cli.md](cli.md) |
|
|
|
|
|
| Look up every CLI flag and config field | [cli-reference.md](cli-reference.md) |
|
docs(cluster): operator how-to guide for deploying and managing clusters
New docs/user/cluster.md — the practical companion to cluster-config.md's
reference: zero-to-served walkthrough (validate/import/plan/apply, derived
roots, data loading, --cluster serving), the day-2 edit->plan->apply->restart
loop with a per-change-kind table, drift observation and convergence, the
approval gate for destructive changes, crash/lock/lost-ledger recovery, the
boot-refusal table with remedies, deployment patterns (replicas, backup
unit, CI gating), and the explicit not-yet list (hot reload, S3-hosted
cluster dirs, per-query exposure, pipelines). Linked from the user index,
the agent guide's topic map, and cross-linked from the reference.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-10 22:10:19 +03:00
|
|
|
| Deploy and operate a cluster (how-to guide) | [cluster.md](cluster.md) |
|
2026-06-08 20:07:39 +03:00
|
|
|
| Validate and plan cluster config | [cluster-config.md](cluster-config.md) |
|
2026-05-15 03:45:22 +03:00
|
|
|
| Write schemas | [schema-language.md](schema-language.md) |
|
|
|
|
|
| Read schema-lint diagnostic codes | [schema-lint.md](schema-lint.md) |
|
|
|
|
|
| Write queries and mutations | [query-language.md](query-language.md) |
|
|
|
|
|
| Use embeddings | [embeddings.md](embeddings.md) |
|
|
|
|
|
|
2026-05-24 16:46:00 +01:00
|
|
|
## Operate A Graph
|
2026-05-15 03:45:22 +03:00
|
|
|
|
|
|
|
|
| Goal | Read |
|
|
|
|
|
|---|---|
|
2026-05-24 16:46:00 +01:00
|
|
|
| Understand graph layout and URI support | [storage.md](storage.md) |
|
2026-05-15 03:45:22 +03:00
|
|
|
| Work with branches, commits, and snapshots | [branches-commits.md](branches-commits.md) |
|
|
|
|
|
| Coordinate multi-query workflows | [transactions.md](transactions.md) |
|
|
|
|
|
| Read diffs and change feeds | [changes.md](changes.md) |
|
|
|
|
|
| Build and use indexes | [indexes.md](indexes.md) |
|
|
|
|
|
| Compact and clean old versions | [maintenance.md](maintenance.md) |
|
|
|
|
|
| Interpret errors and output formats | [errors.md](errors.md) |
|
|
|
|
|
|
|
|
|
|
## Run The Server
|
|
|
|
|
|
|
|
|
|
| Goal | Read |
|
|
|
|
|
|---|---|
|
|
|
|
|
| Deploy the binary or container | [deployment.md](deployment.md) |
|
|
|
|
|
| Use HTTP endpoints | [server.md](server.md) |
|
|
|
|
|
| Configure Cedar authorization | [policy.md](policy.md) |
|
|
|
|
|
| Track actors and audit behavior | [audit.md](audit.md) |
|
|
|
|
|
|
|
|
|
|
## Releases
|
|
|
|
|
|
|
|
|
|
Release notes live in [releases/](../releases/). Use them for user-visible
|
|
|
|
|
changes between versions, not for contributor design history.
|
|
|
|
|
|
|
|
|
|
## Boundary
|
|
|
|
|
|
|
|
|
|
User docs should focus on stable behavior. If a paragraph needs to explain
|
|
|
|
|
internal sidecars, Lance API blockers, MR numbers, test strategy, or review
|
|
|
|
|
rules, it probably belongs in [docs/dev/index.md](../dev/index.md) or a developer-area document
|
|
|
|
|
instead.
|
