vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-06 14:50:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add experimental-features page and de-experimentalize dreaming

Browse Source
This commit is contained in:
Vincent Koc
2026-04-15 11:46:25 +01:00
parent f09a4d9ba0
commit a780151fd1
9 changed files with 65 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/concepts/dreaming.md
View File

@@ -1,5 +1,5 @@
---
title: "Dreaming (experimental)"
title: "Dreaming"
summary: "Background memory consolidation with light, deep, and REM phases plus a Dream Diary"
read_when:
- You want memory promotion to run automatically
@@ -7,7 +7,7 @@ read_when:
- You want to tune consolidation without polluting MEMORY.md
---
# Dreaming (experimental)
# Dreaming
Dreaming is the background memory consolidation system in `memory-core`.
It helps OpenClaw move strong short-term signals into durable memory while
@@ -215,7 +215,7 @@ All settings live under `plugins.entries.memory-core.config.dreaming`.
Phase policy, thresholds, and storage behavior are internal implementation
details (not user-facing config).
See [Memory configuration reference](/reference/memory-config#dreaming-experimental)
See [Memory configuration reference](/reference/memory-config#dreaming)
for the full key list.
## Dreams UI

47
docs/concepts/experimental-features.md Normal file
View File

@@ -0,0 +1,47 @@
---
title: "Experimental Features"
summary: "What experimental flags mean in OpenClaw and which ones are currently documented"
read_when:
- You see an `.experimental` config key and want to know whether it is stable
- You want to try preview runtime features without confusing them with normal defaults
- You want one place to find the currently documented experimental flags
---
# Experimental features
Experimental features in OpenClaw are **opt-in preview surfaces**. They are
behind explicit flags because they still need real-world mileage before they
deserve a stable default or a long-lived public contract.
Treat them differently from normal config:
- Keep them **off by default** unless the related doc tells you to try one.
- Expect **shape and behavior to change** faster than stable config.
- Prefer the stable path first when one already exists.
- If you are rolling OpenClaw out broadly, test experimental flags in a smaller
environment before baking them into a shared baseline.
## Currently documented flags
| Surface | Key | Use it when | More |
| ------------------------ | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| Local model runtime | `agents.defaults.experimental.localModelLean` | A smaller or stricter local backend chokes on OpenClaw's full default tool surface | [Local Models](/gateway/local-models) |
| Memory search | `agents.defaults.memorySearch.experimental.sessionMemory` | You want `memory_search` to index prior session transcripts and accept the extra storage/indexing cost | [Memory configuration reference](/reference/memory-config#session-memory-search-experimental) |
| Structured planning tool | `tools.experimental.planTool` | You want the structured `update_plan` tool exposed for multi-step work tracking in compatible runtimes and UIs | [Gateway configuration reference](/gateway/configuration-reference#toolsexperimental) |
## Local model lean mode
`agents.defaults.experimental.localModelLean: true` is a pressure-release valve
for weaker local-model setups. It trims heavyweight default tools like
`browser`, `cron`, and `message` so the prompt shape is smaller and less brittle
for small-context or stricter OpenAI-compatible backends.
That is intentionally **not** the normal path. If your backend handles the full
runtime cleanly, leave this off.
## Experimental does not mean hidden
If a feature is experimental, OpenClaw should say so plainly in docs and in the
config path itself. What it should **not** do is smuggle preview behavior into a
stable-looking default knob and pretend that is normal. That's how config
surfaces get messy.

8
docs/concepts/memory.md
View File

@@ -20,7 +20,7 @@ Your agent has three memory-related files:
decisions. Loaded at the start of every DM session.
- **`memory/YYYY-MM-DD.md`** -- daily notes. Running context and observations.
Today and yesterday's notes are loaded automatically.
- **`DREAMS.md`** (experimental, optional) -- Dream Diary and dreaming sweep
- **`DREAMS.md`** (optional) -- Dream Diary and dreaming sweep
summaries for human review, including grounded historical backfill entries.
These files live in the agent workspace (default `~/.openclaw/workspace`).
@@ -114,7 +114,7 @@ important facts in the conversation that are not yet written to a file, they
will be saved automatically before the summary happens.
</Tip>
## Dreaming (experimental)
## Dreaming
Dreaming is an optional background consolidation pass for memory. It collects
short-term signals, scores candidates, and promotes only qualified items into
@@ -131,7 +131,7 @@ It is designed to keep long-term memory high signal:
for human review.
For phase behavior, scoring signals, and Dream Diary details, see
[Dreaming (experimental)](/concepts/dreaming).
[Dreaming](/concepts/dreaming).
## Grounded backfill and live promotion
@@ -184,7 +184,7 @@ openclaw memory index --force # Rebuild the index
- [Memory Wiki](/plugins/memory-wiki) -- compiled knowledge vault and wiki-native tools
- [Memory Search](/concepts/memory-search) -- search pipeline, providers, and
tuning
- [Dreaming (experimental)](/concepts/dreaming) -- background promotion
- [Dreaming](/concepts/dreaming) -- background promotion
from short-term recall to long-term memory
- [Memory configuration reference](/reference/memory-config) -- all config knobs
- [Compaction](/concepts/compaction) -- how compaction interacts with memory