Skip to content

Commit 91e835e

Browse files
committed
docs(concepts): batch readability and Mintlify component pass
- memory: replace en-dash list separators with em-dashes, sentence-case Further reading link titles - messages: rewrite filler 'this page ties together' opener to a direct one - delegate-architecture: convert 4 blockquote security warnings to Warning and Note components - system-prompt: convert blockquote daily-memory note to Note component
1 parent 5d5c377 commit 91e835e

4 files changed

Lines changed: 32 additions & 30 deletions

File tree

docs/concepts/delegate-architecture.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,15 @@ The delegate operates **autonomously** on a schedule, executing standing orders
7070

7171
This tier combines Tier 2 permissions with [Cron Jobs](/automation/cron-jobs) and [Standing Orders](/automation/standing-orders).
7272

73-
> **Security warning**: Tier 3 requires careful configuration of hard blocks — actions the agent must never take regardless of instruction. Complete the prerequisites below before granting any identity provider permissions.
73+
<Warning>
74+
Tier 3 requires careful configuration of hard blocks: actions the agent must never take regardless of instruction. Complete the prerequisites below before granting any identity provider permissions.
75+
</Warning>
7476

7577
## Prerequisites: isolation and hardening
7678

77-
> **Do this first.** Before you grant any credentials or identity provider access, lock down the delegate's boundaries. The steps in this section define what the agent **cannot** do — establish these constraints before giving it the ability to do anything.
79+
<Note>
80+
**Do this first.** Before you grant any credentials or identity provider access, lock down the delegate's boundaries. The steps in this section define what the agent **cannot** do. Establish these constraints before giving it the ability to do anything.
81+
</Note>
7882

7983
### Hard blocks (non-negotiable)
8084

@@ -180,7 +184,9 @@ New-ApplicationAccessPolicy `
180184
-AccessRight RestrictAccess
181185
```
182186

183-
> **Security warning**: without an application access policy, `Mail.Read` application permission grants access to **every mailbox in the tenant**. Always create the access policy before the application reads any mail. Test by confirming the app returns `403` for mailboxes outside the security group.
187+
<Warning>
188+
Without an application access policy, `Mail.Read` application permission grants access to **every mailbox in the tenant**. Always create the access policy before the application reads any mail. Test by confirming the app returns `403` for mailboxes outside the security group.
189+
</Warning>
184190

185191
#### Google Workspace
186192

@@ -196,7 +202,9 @@ https://www.googleapis.com/auth/calendar # Tier 2
196202

197203
The service account impersonates the delegate user (not the principal), preserving the "on behalf of" model.
198204

199-
> **Security warning**: domain-wide delegation allows the service account to impersonate **any user in the entire domain**. Restrict the scopes to the minimum required, and limit the service account's client ID to only the scopes listed above in the Admin Console (Security > API controls > Domain-wide delegation). A leaked service account key with broad scopes grants full access to every mailbox and calendar in the organization. Rotate keys on a schedule and monitor the Admin Console audit log for unexpected impersonation events.
205+
<Warning>
206+
Domain-wide delegation allows the service account to impersonate **any user in the entire domain**. Restrict the scopes to the minimum required, and limit the service account's client ID to only the scopes listed above in the Admin Console (Security > API controls > Domain-wide delegation). A leaked service account key with broad scopes grants full access to every mailbox and calendar in the organization. Rotate keys on a schedule and monitor the Admin Console audit log for unexpected impersonation events.
207+
</Warning>
200208

201209
### 3. Bind the delegate to channels
202210

docs/concepts/memory.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ read_when:
77
---
88

99
OpenClaw remembers things by writing **plain Markdown files** in your agent's
10-
workspace. The model only "remembers" what gets saved to disk -- there is no
10+
workspace. The model only "remembers" what gets saved to disk there is no
1111
hidden state.
1212

1313
## How it works
1414

1515
Your agent has three memory-related files:
1616

17-
- **`MEMORY.md`** -- long-term memory. Durable facts, preferences, and
17+
- **`MEMORY.md`** long-term memory. Durable facts, preferences, and
1818
decisions. Loaded at the start of every DM session.
19-
- **`memory/YYYY-MM-DD.md`** -- daily notes. Running context and observations.
19+
- **`memory/YYYY-MM-DD.md`** daily notes. Running context and observations.
2020
Today and yesterday's notes are loaded automatically.
21-
- **`DREAMS.md`** (optional) -- Dream Diary and dreaming sweep
21+
- **`DREAMS.md`** (optional) Dream Diary and dreaming sweep
2222
summaries for human review, including grounded historical backfill entries.
2323

2424
These files live in the agent workspace (default `~/.openclaw/workspace`).
@@ -32,9 +32,9 @@ prefer TypeScript." It will write it to the appropriate file.
3232

3333
The agent has two tools for working with memory:
3434

35-
- **`memory_search`** -- finds relevant notes using semantic search, even when
35+
- **`memory_search`** finds relevant notes using semantic search, even when
3636
the wording differs from the original.
37-
- **`memory_get`** -- reads a specific memory file or line range.
37+
- **`memory_get`** reads a specific memory file or line range.
3838

3939
Both tools are provided by the active memory plugin (default: `memory-core`).
4040

@@ -61,7 +61,7 @@ See [Memory Wiki](/plugins/memory-wiki).
6161
## Memory search
6262

6363
When an embedding provider is configured, `memory_search` uses **hybrid
64-
search** -- combining vector similarity (semantic meaning) with keyword matching
64+
search** combining vector similarity (semantic meaning) with keyword matching
6565
(exact terms like IDs and code symbols). This works out of the box once you have
6666
an API key for any supported provider.
6767

@@ -104,7 +104,7 @@ dashboards, bridge mode, and Obsidian-friendly workflows.
104104

105105
Before [compaction](/concepts/compaction) summarizes your conversation, OpenClaw
106106
runs a silent turn that reminds the agent to save important context to memory
107-
files. This is on by default -- you do not need to configure anything.
107+
files. This is on by default you do not need to configure anything.
108108

109109
<Tip>
110110
The memory flush prevents context loss during compaction. If your agent has
@@ -176,16 +176,14 @@ openclaw memory index --force # Rebuild the index
176176

177177
## Further reading
178178

179-
- [Builtin Memory Engine](/concepts/memory-builtin) -- default SQLite backend
180-
- [QMD Memory Engine](/concepts/memory-qmd) -- advanced local-first sidecar
181-
- [Honcho Memory](/concepts/memory-honcho) -- AI-native cross-session memory
182-
- [Memory Wiki](/plugins/memory-wiki) -- compiled knowledge vault and wiki-native tools
183-
- [Memory Search](/concepts/memory-search) -- search pipeline, providers, and
184-
tuning
185-
- [Dreaming](/concepts/dreaming) -- background promotion
186-
from short-term recall to long-term memory
187-
- [Memory configuration reference](/reference/memory-config) -- all config knobs
188-
- [Compaction](/concepts/compaction) -- how compaction interacts with memory
179+
- [Builtin memory engine](/concepts/memory-builtin): default SQLite backend.
180+
- [QMD memory engine](/concepts/memory-qmd): advanced local-first sidecar.
181+
- [Honcho memory](/concepts/memory-honcho): AI-native cross-session memory.
182+
- [Memory Wiki](/plugins/memory-wiki): compiled knowledge vault and wiki-native tools.
183+
- [Memory search](/concepts/memory-search): search pipeline, providers, and tuning.
184+
- [Dreaming](/concepts/dreaming): background promotion from short-term recall to long-term memory.
185+
- [Memory configuration reference](/reference/memory-config): all config knobs.
186+
- [Compaction](/concepts/compaction): how compaction interacts with memory.
189187

190188
## Related
191189

docs/concepts/messages.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ read_when:
77
title: "Messages"
88
---
99

10-
This page ties together how OpenClaw handles inbound messages, sessions, queueing,
11-
streaming, and reasoning visibility.
10+
OpenClaw handles inbound messages through a pipeline of session resolution, queueing, streaming, tool execution, and reasoning visibility. This page maps the path from inbound message to reply.
1211

1312
## Message flow (high level)
1413

docs/concepts/system-prompt.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,9 @@ heartbeats are disabled for the default agent or
116116
files concise — especially `MEMORY.md`, which can grow over time and lead to
117117
unexpectedly high context usage and more frequent compaction.
118118

119-
> **Note:** `memory/*.md` daily files are **not** part of the normal bootstrap
120-
> Project Context. On ordinary turns they are accessed on demand via the
121-
> `memory_search` and `memory_get` tools, so they do not count against the
122-
> context window unless the model explicitly reads them. Bare `/new` and
123-
> `/reset` turns are the exception: the runtime can prepend recent daily memory
124-
> as a one-shot startup-context block for that first turn.
119+
<Note>
120+
`memory/*.md` daily files are **not** part of the normal bootstrap Project Context. On ordinary turns they are accessed on demand via the `memory_search` and `memory_get` tools, so they do not count against the context window unless the model explicitly reads them. Bare `/new` and `/reset` turns are the exception: the runtime can prepend recent daily memory as a one-shot startup-context block for that first turn.
121+
</Note>
125122

126123
Large files are truncated with a marker. The max per-file size is controlled by
127124
`agents.defaults.bootstrapMaxChars` (default: 12000). Total injected bootstrap

0 commit comments

Comments
 (0)