From 5bba899a70623737ad8a6fc0ed964df97cfaed7e Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Sun, 26 Apr 2026 22:11:54 -0700 Subject: [PATCH] docs: batch fix filler Note/page openers and one TUI auth Warning - gateway/authentication: tighten model-provider Note opener - help/debugging: drop 'this page covers' filler - reference/session-management-compaction: rephrase end-to-end intro - reference/transcript-hygiene: drop 'this document describes' filler - web/index: collapse 'this page focuses' filler - web/tui: convert prose --url Note to Warning component --- docs/gateway/authentication.md | 2 +- docs/help/debugging.md | 3 +-- docs/reference/session-management-compaction.md | 6 +++--- docs/reference/transcript-hygiene.md | 6 +----- docs/web/index.md | 3 +-- docs/web/tui.md | 6 +++--- 6 files changed, 10 insertions(+), 16 deletions(-) diff --git a/docs/gateway/authentication.md b/docs/gateway/authentication.md index 903e5cd03d9..dac0dd0dd4b 100644 --- a/docs/gateway/authentication.md +++ b/docs/gateway/authentication.md @@ -7,7 +7,7 @@ title: "Authentication" --- -This page covers **model provider** authentication (API keys, OAuth, Claude CLI reuse, and Anthropic setup-token). For **gateway connection** authentication (token, password, trusted-proxy), see [Configuration](/gateway/configuration) and [Trusted Proxy Auth](/gateway/trusted-proxy-auth). +This page is the **model provider** authentication reference (API keys, OAuth, Claude CLI reuse, and Anthropic setup-token). For **gateway connection** authentication (token, password, trusted-proxy), see [Configuration](/gateway/configuration) and [Trusted Proxy Auth](/gateway/trusted-proxy-auth). OpenClaw supports OAuth and API keys for model providers. For always-on gateway diff --git a/docs/help/debugging.md b/docs/help/debugging.md index 28c3cbd4103..285c2402313 100644 --- a/docs/help/debugging.md +++ b/docs/help/debugging.md @@ -7,8 +7,7 @@ read_when: title: "Debugging" --- -This page covers debugging helpers for streaming output, especially when a -provider mixes reasoning into normal text. +Debugging helpers for streaming output, especially when a provider mixes reasoning into normal text. ## Runtime debug overrides diff --git a/docs/reference/session-management-compaction.md b/docs/reference/session-management-compaction.md index a1e2ab7cd66..aa83a33a418 100644 --- a/docs/reference/session-management-compaction.md +++ b/docs/reference/session-management-compaction.md @@ -7,15 +7,15 @@ read_when: title: "Session management deep dive" --- -This page explains how OpenClaw manages sessions end-to-end: +OpenClaw manages sessions end-to-end across these areas: - **Session routing** (how inbound messages map to a `sessionKey`) - **Session store** (`sessions.json`) and what it tracks - **Transcript persistence** (`*.jsonl`) and its structure - **Transcript hygiene** (provider-specific fixups before runs) - **Context limits** (context window vs tracked tokens) -- **Compaction** (manual + auto-compaction) and where to hook pre-compaction work -- **Silent housekeeping** (e.g. memory writes that shouldn’t produce user-visible output) +- **Compaction** (manual and auto-compaction) and where to hook pre-compaction work +- **Silent housekeeping** (memory writes that should not produce user-visible output) If you want a higher-level overview first, start with: diff --git a/docs/reference/transcript-hygiene.md b/docs/reference/transcript-hygiene.md index 5185b51b6dc..4d6ac90a20d 100644 --- a/docs/reference/transcript-hygiene.md +++ b/docs/reference/transcript-hygiene.md @@ -7,11 +7,7 @@ read_when: title: "Transcript hygiene" --- -This document describes **provider-specific fixes** applied to transcripts before a run -(building model context). Most of these are **in-memory** adjustments used to satisfy -strict provider requirements. A separate session-file repair pass may also rewrite -stored JSONL before the session is loaded, either by dropping malformed JSONL lines or -by repairing persisted turns that are syntactically valid but known to be rejected by a +OpenClaw applies **provider-specific fixes** to transcripts before a run (building model context). Most of these are **in-memory** adjustments used to satisfy strict provider requirements. A separate session-file repair pass may also rewrite stored JSONL before the session is loaded, either by dropping malformed JSONL lines or by repairing persisted turns that are syntactically valid but known to be rejected by a provider during replay. When a repair occurs, the original file is backed up alongside the session file. diff --git a/docs/web/index.md b/docs/web/index.md index 4ead80976f7..6c91277b8fb 100644 --- a/docs/web/index.md +++ b/docs/web/index.md @@ -12,8 +12,7 @@ The Gateway serves a small **browser Control UI** (Vite + Lit) from the same por - with `gateway.tls.enabled: true`: `https://:18789/` - optional prefix: set `gateway.controlUi.basePath` (e.g. `/openclaw`) -Capabilities live in [Control UI](/web/control-ui). -This page focuses on bind modes, security, and web-facing surfaces. +Capabilities live in [Control UI](/web/control-ui). The rest of this page focuses on bind modes, security, and web-facing surfaces. ## Webhooks diff --git a/docs/web/tui.md b/docs/web/tui.md index 04da9f7c8a5..540c349d837 100644 --- a/docs/web/tui.md +++ b/docs/web/tui.md @@ -217,9 +217,9 @@ Tips: - `--timeout-ms `: Agent timeout in ms (defaults to `agents.defaults.timeoutSeconds`) - `--history-limit `: History entries to load (default `200`) -Note: when you set `--url`, the TUI does not fall back to config or environment credentials. -Pass `--token` or `--password` explicitly. Missing explicit credentials is an error. -In local mode, do not pass `--url`, `--token`, or `--password`. + +When you set `--url`, the TUI does not fall back to config or environment credentials. Pass `--token` or `--password` explicitly. Missing explicit credentials is an error. In local mode, do not pass `--url`, `--token`, or `--password`. + ## Troubleshooting