From 4324eac5e9ce93da2266f5a1a2b943f4e0acf524 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 21:26:51 +0100 Subject: [PATCH] docs: refresh config schema metadata mirrors --- docs/cli/config.md | 4 ++-- docs/cli/index.md | 2 +- docs/gateway/configuration.md | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/cli/config.md b/docs/cli/config.md index f795e70df977..c605884ac719 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -53,8 +53,8 @@ Print the generated JSON schema for `openclaw.json` to stdout as JSON. What it includes: - The current root config schema, plus a root `$schema` string field for editor tooling -- Field `title` and `description` metadata derived from the same labels/help used by the Control UI -- Nested object, wildcard (`*`), and array-item (`[]`) nodes inherit the same `title` / `description` metadata when labels/help exist +- Field `title` and `description` docs metadata used by the Control UI +- Nested object, wildcard (`*`), and array-item (`[]`) nodes inherit the same `title` / `description` metadata when matching field documentation exists - Best-effort live plugin + channel schema metadata when runtime manifests can be loaded - A clean fallback schema even when the current config is invalid diff --git a/docs/cli/index.md b/docs/cli/index.md index e0ea6bd34e3b..578775646ca5 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -579,7 +579,7 @@ Subcommands: - `config set --strict-json`: require JSON5 parsing for path/value input. `--json` remains a legacy alias for strict parsing outside dry-run output mode. - `config unset `: remove a value. - `config file`: print the active config file path. -- `config schema`: print the generated JSON schema for `openclaw.json`, including field `title` / `description` metadata and best-effort live plugin/channel schema metadata. +- `config schema`: print the generated JSON schema for `openclaw.json`, including propagated field `title` / `description` docs metadata and best-effort live plugin/channel schema metadata. - `config validate`: validate the current config against the schema without starting the gateway. - `config validate --json`: emit machine-readable JSON output. diff --git a/docs/gateway/configuration.md b/docs/gateway/configuration.md index 08610806765b..42db43b1c626 100644 --- a/docs/gateway/configuration.md +++ b/docs/gateway/configuration.md @@ -52,10 +52,10 @@ See the [full reference](/gateway/configuration-reference) for every available f Open [http://127.0.0.1:18789](http://127.0.0.1:18789) and use the **Config** tab. The Control UI renders a form from the live config schema, including field - labels/help plus plugin and channel schemas when available, with a **Raw - JSON** editor as an escape hatch. For drill-down UIs and other tooling, the - gateway also exposes `config.schema.lookup` to fetch one path-scoped schema - node plus immediate child summaries. + `title` / `description` docs metadata plus plugin and channel schemas when + available, with a **Raw JSON** editor as an escape hatch. For drill-down + UIs and other tooling, the gateway also exposes `config.schema.lookup` to + fetch one path-scoped schema node plus immediate child summaries. Edit `~/.openclaw/openclaw.json` directly. The Gateway watches the file and applies changes automatically (see [hot reload](#config-hot-reload)). @@ -75,7 +75,7 @@ Schema tooling notes: - Field `title` and `description` values are carried into the schema output for editor and form tooling. - Nested object, wildcard (`*`), and array-item (`[]`) entries inherit the same - docs metadata where schema labels/help exist. + docs metadata where matching field documentation exists. - `config.schema.lookup` returns one normalized config path with a shallow schema node (`title`, `description`, `type`, `enum`, `const`, common bounds, and similar validation fields), matched UI hint metadata, and immediate child