Docs: add Reality check + DONE/PARTIAL/ROADMAP status markers#3
Docs: add Reality check + DONE/PARTIAL/ROADMAP status markers#3phenomenoner merged 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9eef85ac10
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
docs/reality-check.md
Outdated
| - `embeddings.count` and `embeddings.models` | ||
| - `ingest` returns something like: | ||
| - `{ "inserted": 2, "ids": [1,2] }` | ||
| - `search` / `timeline` / `get` return JSON arrays of rows containing `id`, `ts`, `kind`, `summary`, and `detail_json`. |
There was a problem hiding this comment.
Fix expected schema for
search results
This expectation is inaccurate for users validating the CLI output: search does not include detail_json in its rows, while timeline and get do. In openclaw_mem/cli.py (cmd_search), the query returns fields like snippet/score but not detail_json, so readers following this “reality check” will see a mismatch and may conclude the command is broken.
Useful? React with 👍 / 👎.
Implements a docs-first, truthful Reality check / Status system (docs-only).
Changes:
docs/reality-check.mdwith verifiable commands + minimal expected JSON output shapes, plus a DONE/PARTIAL/ROADMAP legend.README.mdtop tagline to be sidecar-accurate, added a short Reality check section + Status map, and annotated the feature map with DONE/PARTIAL/ROADMAP.QUICKSTART.mdand key docs to use a working source-checkout invocation (uv run python -m openclaw_mem ...) and removed non-English example text to keep docs fully English.docs/architecture.md,docs/roadmap.md,docs/auto-capture.md, anddocs/importance-grading.md.mkdocs.ymlnav.No code behavior changes.