omnigraph/docs/user
Ragnor Comerford a68896c4a0
docs(readme): embedded quick-start run-through + trimmed Clients (#266)
* docs(readme): add embedded quick-start run-through + trim Clients

- Quick start: a copy-pasteable embedded (local file) run-through
  (schema → init → load → query → branch), followed by a "Storage backends"
  table that surfaces the one thing that changes across embedded / S3 object
  storage / RustFS-MinIO — the graph address — with a pointer to cluster mode
  for served multi-graph deployments.
- Clients: collapse to a two-line pointer (npm packages + omnigraph-ts repo);
  Python SDK marked coming soon.

* docs(readme,quickstart): fix init addressing + drop non-parsing schema commas

Addresses PR review (both verified against source):

- README "Storage backends": `init` takes the graph address as a positional
  argument, not `--store` (`Command::Init { uri: String }`) — Codex. Table now
  shows bare addresses and a note on which flag each verb uses.
- docs/user/quickstart.md: drop trailing commas in the schema. The .pg grammar
  (`prop_decl = { ident ~ ":" ~ type_ref ~ annotation* }`, node body
  `(prop_decl | body_constraint)*`, comma not in WHITESPACE) has no comma rule,
  so `name: String,` fails to parse — Greptile.
2026-06-16 12:36:11 +02:00
..
branching docs(user): de-dev polish — strip internal scaffolding from user docs (Phase 3a) (#226) 2026-06-14 14:39:25 +03:00
cli [codex] fix RFC-011 follow-up regressions (#258) 2026-06-16 03:11:43 +03:00
clusters Merge remote-tracking branch 'origin/main' into ragnorc/shaping-config-integration 2026-06-16 04:13:00 +03:00
concepts docs(user): de-dev polish — strip internal scaffolding from user docs (Phase 3a) (#226) 2026-06-14 14:39:25 +03:00
mutations docs(user): split language/branching pages + add front-door pages (Phase 2) (#225) 2026-06-14 13:53:46 +03:00
operations [codex] fix RFC-011 follow-up regressions (#258) 2026-06-16 03:11:43 +03:00
queries docs(user): de-dev polish — strip internal scaffolding from user docs (Phase 3a) (#226) 2026-06-14 14:39:25 +03:00
reference Wire cluster embedding providers 2026-06-16 04:02:08 +03:00
schema docs(embeddings): @embed model arg + same-space validation (RFC-012 Phase 3-4) 2026-06-15 21:09:35 +02:00
search Merge remote-tracking branch 'origin/main' into ragnorc/shaping-config-integration 2026-06-16 04:13:00 +03:00
deployment.md docs: onboarding-first README + in-repo agent skill + drop RustFS script (#257) 2026-06-16 11:48:13 +02:00
index.md docs(user): split language/branching pages + add front-door pages (Phase 2) (#225) 2026-06-14 13:53:46 +03:00
install.md Add Windows release binaries (#127) 2026-05-30 14:23:40 +02:00
quickstart.md docs(readme): embedded quick-start run-through + trimmed Clients (#266) 2026-06-16 12:36:11 +02:00