Skip to content

Commit f531eff

Browse files
committed
docs: audit and fix 5 pages (typography hygiene + dup H1)
1 parent 06c490f commit f531eff

5 files changed

Lines changed: 8 additions & 10 deletions

File tree

docs/concepts/typebox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Authoritative advertised **discovery** inventory lives in
6464
## Current pipeline
6565

6666
- `pnpm protocol:gen`
67-
- writes JSON Schema (draft07) to `dist/protocol.schema.json`
67+
- writes JSON Schema (draft-07) to `dist/protocol.schema.json`
6868
- `pnpm protocol:gen:swift`
6969
- generates Swift gateway models
7070
- `pnpm protocol:check`

docs/concepts/usage-tracking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ title: "Usage tracking"
2020

2121
## Where it shows up
2222

23-
- `/status` in chats: emojirich status card with session tokens + estimated cost (API key only). Provider usage shows for the **current model provider** when available as a normalized `X% left` window.
23+
- `/status` in chats: emoji-rich status card with session tokens + estimated cost (API key only). Provider usage shows for the **current model provider** when available as a normalized `X% left` window.
2424
- `/usage off|tokens|full` in chats: per-response usage footer (OAuth shows tokens only).
2525
- `/usage cost` in chats: local cost summary aggregated from OpenClaw session logs.
2626
- CLI: `openclaw status --usage` prints a full per-provider breakdown.
2727
- CLI: `openclaw channels list` prints the same usage snapshot alongside provider config (use `--no-usage` to skip).
28-
- macOS menu bar: Usage section under Context (only if available).
28+
- macOS menu bar: "Usage" section under Context (only if available).
2929

3030
## Providers + credentials
3131

docs/install/hetzner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: "Hetzner"
1414

1515
Run a persistent OpenClaw Gateway on a Hetzner VPS using Docker, with durable state, baked-in binaries, and safe restart behavior.
1616

17-
If you want OpenClaw 24/7 for ~$5, this is the simplest reliable setup.
17+
If you want "OpenClaw 24/7 for ~$5", this is the simplest reliable setup.
1818
Hetzner pricing changes; pick the smallest Debian/Ubuntu VPS and scale up if you hit OOMs.
1919

2020
Security model reminder:

docs/reference/test.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: "Tests"
88
- Full testing kit (suites, live, Docker): [Testing](/help/testing)
99
- Update and plugin package validation: [Testing updates and plugins](/help/testing-updates-plugins)
1010

11-
- `pnpm test:force`: Kills any lingering gateway process holding the default control port, then runs the full Vitest suite with an isolated gateway port so server tests dont collide with a running instance. Use this when a prior gateway run left port 18789 occupied.
11+
- `pnpm test:force`: Kills any lingering gateway process holding the default control port, then runs the full Vitest suite with an isolated gateway port so server tests don't collide with a running instance. Use this when a prior gateway run left port 18789 occupied.
1212
- `pnpm test:coverage`: Runs the unit suite with V8 coverage (via `vitest.unit.config.ts`). This is a default-unit-lane coverage gate, not whole-repo all-file coverage. Thresholds are 70% lines/functions/statements and 55% branches. Because `coverage.all` is false and the default lane scopes coverage includes to non-fast unit tests with sibling source files, the gate measures source owned by this lane instead of every transitive import it happens to load.
1313
- `pnpm test:coverage:changed`: Runs unit coverage only for files changed since `origin/main`.
1414
- `pnpm test:changed`: cheap smart changed test run. It runs precise targets from direct test edits, sibling `*.test.ts` files, explicit source mappings, and the local import graph. Broad/config/package changes are skipped unless they map to precise tests.
@@ -72,7 +72,7 @@ Usage:
7272

7373
- `source ~/.profile && pnpm tsx scripts/bench-model.ts --runs 10`
7474
- Optional env: `MINIMAX_API_KEY`, `MINIMAX_BASE_URL`, `MINIMAX_MODEL`, `ANTHROPIC_API_KEY`
75-
- Default prompt: Reply with a single word: ok. No punctuation or extra text.
75+
- Default prompt: "Reply with a single word: ok. No punctuation or extra text."
7676

7777
Last run (2025-12-31, 20 runs):
7878

docs/reference/token-use.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ read_when:
66
title: "Token use and costs"
77
---
88

9-
# Token use & costs
10-
119
OpenClaw tracks **tokens**, not characters. Tokens are model-specific, but most
1210
OpenAI-style models average ~4 characters per token for English text.
1311

@@ -63,7 +61,7 @@ For a practical breakdown (per injected file, tools, skills, and system prompt s
6361

6462
Use these in chat:
6563

66-
- `/status`**emojirich status card** with the session model, context usage,
64+
- `/status`**emoji-rich status card** with the session model, context usage,
6765
last response input/output tokens, and **estimated cost** (API key only).
6866
- `/usage off|tokens|full` → appends a **per-response usage footer** to every reply.
6967
- Persists per session (stored as `responseUsage`).
@@ -149,7 +147,7 @@ per agent with `agents.list[].params.cacheRetention`.
149147
For a full knob-by-knob guide, see [Prompt Caching](/reference/prompt-caching).
150148

151149
For Anthropic API pricing, cache reads are significantly cheaper than input
152-
tokens, while cache writes are billed at a higher multiplier. See Anthropics
150+
tokens, while cache writes are billed at a higher multiplier. See Anthropic's
153151
prompt caching pricing for the latest rates and TTL multipliers:
154152
[https://docs.anthropic.com/docs/build-with-claude/prompt-caching](https://docs.anthropic.com/docs/build-with-claude/prompt-caching)
155153

0 commit comments

Comments
 (0)