Docs: sweep recent user-facing updates (#46424)

* Docs: document Telegram force-document sends

* Docs: note Telegram document send behavior

* Docs: clarify memory file precedence

* Docs: align default AGENTS memory guidance

* Docs: update workspace FAQ memory note

* Docs: document gateway status require-rpc

* Docs: add require-rpc to gateway CLI index
This commit is contained in:
Vincent Koc 2026-03-14 10:20:44 -07:00 committed by GitHub
parent 0e893347f6
commit c30cabcca4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 26 additions and 5 deletions

View File

@ -782,6 +782,11 @@ openclaw message poll --channel telegram --target -1001234567890:topic:42 \
- `--poll-public` - `--poll-public`
- `--thread-id` for forum topics (or use a `:topic:` target) - `--thread-id` for forum topics (or use a `:topic:` target)
Telegram send also supports:
- `--buttons` for inline keyboards when `channels.telegram.capabilities.inlineButtons` allows it
- `--force-document` to send outbound images and GIFs as documents instead of compressed photo or animated-media uploads
Action gating: Action gating:
- `channels.telegram.actions.sendMessage=false` disables outbound Telegram messages, including polls - `channels.telegram.actions.sendMessage=false` disables outbound Telegram messages, including polls

View File

@ -95,6 +95,7 @@ openclaw gateway health --url ws://127.0.0.1:18789
```bash ```bash
openclaw gateway status openclaw gateway status
openclaw gateway status --json openclaw gateway status --json
openclaw gateway status --require-rpc
``` ```
Options: Options:
@ -105,11 +106,13 @@ Options:
- `--timeout <ms>`: probe timeout (default `10000`). - `--timeout <ms>`: probe timeout (default `10000`).
- `--no-probe`: skip the RPC probe (service-only view). - `--no-probe`: skip the RPC probe (service-only view).
- `--deep`: scan system-level services too. - `--deep`: scan system-level services too.
- `--require-rpc`: exit non-zero when the RPC probe fails. Cannot be combined with `--no-probe`.
Notes: Notes:
- `gateway status` resolves configured auth SecretRefs for probe auth when possible. - `gateway status` resolves configured auth SecretRefs for probe auth when possible.
- If a required auth SecretRef is unresolved in this command path, probe auth can fail; pass `--token`/`--password` explicitly or resolve the secret source first. - If a required auth SecretRef is unresolved in this command path, probe auth can fail; pass `--token`/`--password` explicitly or resolve the secret source first.
- Use `--require-rpc` in scripts and automation when a listening service is not enough and you need the Gateway RPC itself to be healthy.
- On Linux systemd installs, service auth drift checks read both `Environment=` and `EnvironmentFile=` values from the unit (including `%h`, quoted paths, multiple files, and optional `-` files). - On Linux systemd installs, service auth drift checks read both `Environment=` and `EnvironmentFile=` values from the unit (including `%h`, quoted paths, multiple files, and optional `-` files).
### `gateway probe` ### `gateway probe`

View File

@ -780,7 +780,7 @@ Subcommands:
Notes: Notes:
- `gateway status` probes the Gateway RPC by default using the services resolved port/config (override with `--url/--token/--password`). - `gateway status` probes the Gateway RPC by default using the services resolved port/config (override with `--url/--token/--password`).
- `gateway status` supports `--no-probe`, `--deep`, and `--json` for scripting. - `gateway status` supports `--no-probe`, `--deep`, `--require-rpc`, and `--json` for scripting.
- `gateway status` also surfaces legacy or extra gateway services when it can detect them (`--deep` adds system-level scans). Profile-named OpenClaw services are treated as first-class and aren't flagged as "extra". - `gateway status` also surfaces legacy or extra gateway services when it can detect them (`--deep` adds system-level scans). Profile-named OpenClaw services are treated as first-class and aren't flagged as "extra".
- `gateway status` prints which config path the CLI uses vs which config the service likely uses (service env), plus the resolved probe target URL. - `gateway status` prints which config path the CLI uses vs which config the service likely uses (service env), plus the resolved probe target URL.
- On Linux systemd installs, status token-drift checks include both `Environment=` and `EnvironmentFile=` unit sources. - On Linux systemd installs, status token-drift checks include both `Environment=` and `EnvironmentFile=` unit sources.

View File

@ -59,6 +59,7 @@ Name lookup:
- Required: `--target`, plus `--message` or `--media` - Required: `--target`, plus `--message` or `--media`
- Optional: `--media`, `--reply-to`, `--thread-id`, `--gif-playback` - Optional: `--media`, `--reply-to`, `--thread-id`, `--gif-playback`
- Telegram only: `--buttons` (requires `channels.telegram.capabilities.inlineButtons` to allow it) - Telegram only: `--buttons` (requires `channels.telegram.capabilities.inlineButtons` to allow it)
- Telegram only: `--force-document` (send images and GIFs as documents to avoid Telegram compression)
- Telegram only: `--thread-id` (forum topic id) - Telegram only: `--thread-id` (forum topic id)
- Slack only: `--thread-id` (thread timestamp; `--reply-to` uses the same field) - Slack only: `--thread-id` (thread timestamp; `--reply-to` uses the same field)
- WhatsApp only: `--gif-playback` - WhatsApp only: `--gif-playback`
@ -258,3 +259,10 @@ Send Telegram inline buttons:
openclaw message send --channel telegram --target @mychat --message "Choose:" \ openclaw message send --channel telegram --target @mychat --message "Choose:" \
--buttons '[ [{"text":"Yes","callback_data":"cmd:yes"}], [{"text":"No","callback_data":"cmd:no"}] ]' --buttons '[ [{"text":"Yes","callback_data":"cmd:yes"}], [{"text":"No","callback_data":"cmd:no"}] ]'
``` ```
Send a Telegram image as a document to avoid compression:
```bash
openclaw message send --channel telegram --target @mychat \
--media ./diagram.png --force-document
```

View File

@ -23,6 +23,8 @@ The default workspace layout uses two memory layers:
- Read today + yesterday at session start. - Read today + yesterday at session start.
- `MEMORY.md` (optional) - `MEMORY.md` (optional)
- Curated long-term memory. - Curated long-term memory.
- If both `MEMORY.md` and `memory.md` exist at the workspace root, OpenClaw only loads `MEMORY.md`.
- Lowercase `memory.md` is only used as a fallback when `MEMORY.md` is absent.
- **Only load in the main, private session** (never in group contexts). - **Only load in the main, private session** (never in group contexts).
These files live under the workspace (`agents.defaults.workspace`, default These files live under the workspace (`agents.defaults.workspace`, default

View File

@ -1358,7 +1358,8 @@ Your **workspace** (AGENTS.md, memory files, skills, etc.) is separate and confi
These files live in the **agent workspace**, not `~/.openclaw`. These files live in the **agent workspace**, not `~/.openclaw`.
- **Workspace (per agent)**: `AGENTS.md`, `SOUL.md`, `IDENTITY.md`, `USER.md`, - **Workspace (per agent)**: `AGENTS.md`, `SOUL.md`, `IDENTITY.md`, `USER.md`,
`MEMORY.md` (or `memory.md`), `memory/YYYY-MM-DD.md`, optional `HEARTBEAT.md`. `MEMORY.md` (or legacy fallback `memory.md` when `MEMORY.md` is absent),
`memory/YYYY-MM-DD.md`, optional `HEARTBEAT.md`.
- **State dir (`~/.openclaw`)**: config, credentials, auth profiles, sessions, logs, - **State dir (`~/.openclaw`)**: config, credentials, auth profiles, sessions, logs,
and shared skills (`~/.openclaw/skills`). and shared skills (`~/.openclaw/skills`).

View File

@ -48,7 +48,8 @@ cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
## Session start (required) ## Session start (required)
- Read `SOUL.md`, `USER.md`, `memory.md`, and today+yesterday in `memory/`. - Read `SOUL.md`, `USER.md`, and today+yesterday in `memory/`.
- Read `MEMORY.md` when present; only fall back to lowercase `memory.md` when `MEMORY.md` is absent.
- Do it before responding. - Do it before responding.
## Soul (required) ## Soul (required)
@ -65,8 +66,9 @@ cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
## Memory system (recommended) ## Memory system (recommended)
- Daily log: `memory/YYYY-MM-DD.md` (create `memory/` if needed). - Daily log: `memory/YYYY-MM-DD.md` (create `memory/` if needed).
- Long-term memory: `memory.md` for durable facts, preferences, and decisions. - Long-term memory: `MEMORY.md` for durable facts, preferences, and decisions.
- On session start, read today + yesterday + `memory.md` if present. - Lowercase `memory.md` is legacy fallback only; do not keep both root files on purpose.
- On session start, read today + yesterday + `MEMORY.md` when present, otherwise `memory.md`.
- Capture: decisions, preferences, constraints, open loops. - Capture: decisions, preferences, constraints, open loops.
- Avoid secrets unless explicitly requested. - Avoid secrets unless explicitly requested.