openclaw/docs/announcements
Vincent Koc f72699f858
docs: STE pass on terminology consistency and run-on sentences (#143770)
* docs: STE pass on terminology consistency and run-on sentences

Closes a batch of ASD-STE100 audit findings grouped by the two most
objectively checkable rules in .audit/ste-policy.md: one word / one
meaning (scan-checklist item 1) and run-on sentences joined by
semicolons (item 5, Rule 8.1).

Terminology:
- Normalize the component name to "Gateway" in prose on
  announcements/bluebubbles-imessage, channels/line, gateway/discovery,
  install/docker, install/digitalocean, install/northflank,
  platforms/android, platforms/ios, platforms/mac/remote.
  Hyphenated attributive compounds (per-gateway, gateway-host,
  gateway-side) stay lowercase, matching the tree and the
  user@gateway-host placeholder mandated by docs/AGENTS.md.
- gateway/discovery: "Node Gateway" -> "Gateway" (used once).
- platforms/mac/remote: "Web Chat" -> "WebChat" (157:7 in the tree).
  The "## Web Chat" heading becomes "## WebChat" with an
  <a id="web-chat" /> stub so the published id survives.
- platforms/android, platforms/ios: one arrow form for menu paths (->
  and > become the dominant ->).
- providers/moonshot: "Kimi Code K3" -> "Kimi Coding K3" in prose;
  vendor product names in link labels are unchanged.
- tools/diffs: one plugin name in the page ("Diff Viewer Language
  Pack plugin", the label in official-external-plugin-catalog.json).

Run-on sentences (Rule 8.1) split into separate sentences on
cli/hooks, cli/webhooks, channels/matrix-push-rules, channels/a2a,
plugins/plugin-permission-requests, plugins/llama-cpp,
platforms/mac/canvas, platforms/mac/health, plugins/teams-meetings,
plugins/zoom-meetings, providers/mistral, tools/diffs,
gateway/secrets-plan-contract, concepts/session-pruning.
The two scrub passes in gateway/secrets-plan-contract and the
changed-files summary card in tools/diffs become lists.

Concrete defects:
- gateway/telemetry: drop the dangling "and applies".
- plugins/zalouser: the opening sentence fragment gets a subject and
  a verb.
- tools/exa-search: the intro named "keyword" and "hybrid" modes that
  the mode table does not list; it now names the table's own ids.
- concepts/session-pruning: state the real ttl default (5 minutes when
  cache-ttl mode is on with no ttl set, per
  resolveCacheTtlPruningSettings) instead of "default 5 minutes when
  set manually".

No fact, hedge, scope qualifier or number changed. No anchor id was
dropped: ids enumerated with parseDocsDocument before and after are
identical across all 28 files except remote.md, which gains "webchat"
and keeps "web-chat".

* docs: turn the diffs baseUrl rules into a list

Three validation rules were joined by two semicolons on one line
(Rule 8.1, and the policy's 'lists for 3 or more conditions'). The
rules and their order are unchanged.

* docs: drop the secrets-plan-contract edit from this PR

.github/CODEOWNERS routes docs/gateway/secrets-plan-contract.md to
@openclaw/openclaw-secops, and this PR has no secops involvement to
point at. ClawSweeper blocked on that and offered omitting the
restricted-path edit as the alternative. The file is back to its
merge-base blob; audit finding r5-0018 is deferred to a secops-routed
PR.

---------

Co-authored-by: Vincent Koc <vincent@openclaw.org>
2026-09-10 15:51:49 +09:00
..
bluebubbles-imessage.md docs: STE pass on terminology consistency and run-on sentences (#143770) 2026-09-10 15:51:49 +09:00