Skip to content

Docs: add Reality check + DONE/PARTIAL/ROADMAP status markers#3

Merged
phenomenoner merged 2 commits intomainfrom
docs/reality-check-status
Feb 12, 2026
Merged

Docs: add Reality check + DONE/PARTIAL/ROADMAP status markers#3
phenomenoner merged 2 commits intomainfrom
docs/reality-check-status

Conversation

@phenomenoner
Copy link
Owner

@phenomenoner phenomenoner commented Feb 12, 2026

Implements a docs-first, truthful Reality check / Status system (docs-only).

Changes:

  • Added docs/reality-check.md with verifiable commands + minimal expected JSON output shapes, plus a DONE/PARTIAL/ROADMAP legend.
  • Updated README.md top tagline to be sidecar-accurate, added a short Reality check section + Status map, and annotated the feature map with DONE/PARTIAL/ROADMAP.
  • Updated QUICKSTART.md and 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.
  • Added lightweight status annotations to docs/architecture.md, docs/roadmap.md, docs/auto-capture.md, and docs/importance-grading.md.
  • Exposed the new page in mkdocs.yml nav.

No code behavior changes.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

- `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`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@phenomenoner phenomenoner merged commit e5f079e into main Feb 12, 2026
2 checks passed
@phenomenoner phenomenoner deleted the docs/reality-check-status branch February 12, 2026 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant