Skip to content

docs: document the OpenClaw integration - #1340

Merged
Teingi merged 6 commits into
masterfrom
docs/openclaw-integration
Aug 25, 2026
Merged

docs: document the OpenClaw integration#1340
Teingi merged 6 commits into
masterfrom
docs/openclaw-integration

Conversation

@AlexStocks

Copy link
Copy Markdown
Contributor

Closes #1317

Rationale for this change

The OpenClaw integration shipped in #1282 (setup openclaw, the memory-powercontext plugin, and CLI tests), but the
integration lists in the three localized READMEs and the documentation site never mention it. This PR brings the
documentation in line with the shipped implementation.

The Pi parts of #1317 were already resolved on master; this PR closes the remaining OpenClaw gap.

What changes are included in this PR?

  • READMEs (EN/CN/JP): add OpenClaw to the "official integrations" sentence and table, and to the Quick Start
    powercontext setup openclaw example and the powercontext doctor comment.
  • New guide: docs/en|zh/docs/how-to/configure-openclaw.md covering install/refresh, plugin behavior (bounded
    recall, source capture, fail-open), scope modes, authenticated Servers, and verification.
  • New integration README: integrations/openclaw/README.md describing the plugin, requirements, setup, and
    development commands.
  • Site navigation: zensical.toml and the EN/ZH docs overview cards link to the new pages.
  • CLI: new powercontext doctor openclaw subcommand that checks the OpenClaw CLI and reports whether
    openclaw plugins list shows the memory-powercontext plugin (with diagnostics tests).

Are there any user-facing changes?

Yes, documentation only. Users gain a working powercontext doctor openclaw verification command and complete
documentation for the existing OpenClaw integration. No public API or persisted format changes.

How was this change tested?

  • pytest tests/test_openclaw_cli.py tests/test_system_cli.py — 44 passed (11 in test_openclaw_cli.py)
  • ruff check on the changed Python files — clean
  • zensical build -s — documentation builds with no issues

AI usage statement

This PR was created with the WorkBuddy AI assistant (Claude) using the repository's documented workflows, with human
review of every change.

Add the OpenClaw integration to the official integration lists in the
English, Chinese, and Japanese READMEs, and add dedicated guides:

- integrations/openclaw/README.md describing the memory plugin
- docs/en|zh/docs/how-to/configure-openclaw.md install and setup guides
- zensical.toml and docs overview cards linking to the new pages
- powercontext doctor openclaw checking the OpenClaw CLI and the
  memory-powercontext plugin
@Teingi

Teingi commented Aug 25, 2026

Copy link
Copy Markdown
Member

ruff format failed & conflicts

AlexStocks and others added 3 commits August 25, 2026 18:04
Merge the latest master branch into the OpenClaw integration branch so GitHub can build the current pull request. Preserve the OpenClaw and OpenCode documentation entries, and accept Ruff formatting for the two Python files that failed the quality job.

Constraint: Preserve the existing PR history and avoid a force push.

Confidence: High; the merge conflicts and the reported quality failure were reproduced locally.

Scope-risk: Low; manual conflict resolution is limited to five documentation and navigation files, with mechanical formatting in two Python files.

Tested: make check; uv run pytest tests/test_openclaw_cli.py -q; make docs-test; make contract-test.

Not-tested: Full Windows test suite because three current-master OpenCode tests have unrelated Windows file-URI baseline failures; GitHub Linux Python checks were green at the prior PR head.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>
Parse the structured enabled-plugin inventory so doctor rejects disabled, failed, or unselected memory plugins. Keep unreleased OpenClaw setup instructions on the same master revision as the CLI, correct the minimum version, and document Gateway-owned token configuration.

Constraint: Keep the repair within the existing PR file set and preserve released integration instructions.

Confidence: High; each review finding was reproduced against the public CLI, repository tag, or OpenClaw contract before implementation.

Scope-risk: Low; runtime behavior changes only the OpenClaw doctor status check, with synchronized documentation updates.

Tested: make check; uv run pytest tests/test_openclaw_cli.py tests/test_system_cli.py -q; make docs-test; make contract-test.

Not-tested: Full Windows suite because current-master OpenCode tests retain unrelated Windows file-URI baseline failures.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>
Merge the latest master after it advanced during the review repair. The new handoff-report commit does not overlap the OpenClaw PR files, and the merge preserves the 12-file PR surface without conflicts.

Constraint: Preserve both histories and avoid force pushing the PR branch.

Confidence: High; merge-tree and the actual merge reported no conflicts or overlapping changed paths.

Scope-risk: Low; this commit only incorporates the current master parent.

Tested: make check; uv run pytest tests/test_openclaw_cli.py -q; git diff --cached --check.

Not-tested: Full Windows suite because current-master OpenCode tests retain unrelated Windows file-URI baseline failures.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>
Comment thread docs/en/docs/how-to/configure-openclaw.md
Comment thread docs/en/docs/how-to/configure-openclaw.md Outdated
Comment thread docs/en/docs/how-to/configure-openclaw.md Outdated
Comment thread integrations/openclaw/README.md Outdated
Comment thread integrations/openclaw/README.md Outdated
AlexStocks and others added 2 commits August 25, 2026 20:11
Merge the latest master before addressing the new OpenClaw review threads. The navigation changes merge cleanly and preserve the existing PR surface.

Constraint: Preserve both histories and avoid force pushing the PR branch.

Confidence: High; merge-tree and the actual merge completed without conflicts.

Scope-risk: Low; this commit only incorporates the current master parent.

Tested: git diff --cached --check; final PR file inventory remains unchanged.

Not-tested: Runtime gates are deferred to the following review-fix commit.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>
Use the Server's port 8000 as the OpenClaw setup default and keep the standalone configurator consistent. Correct the documented capture boundary, transport policy, Node requirement, and direct bounded memory-read paths.

Constraint: Address only the five current OpenClaw review threads without introducing a new transport-enforcement policy.

Confidence: High; each statement is matched to the CLI, plugin implementation, or the minimum supported OpenClaw release.

Scope-risk: Low; runtime behavior changes only the default OpenClaw endpoint from the unused port 8765 to the Server default 8000.

Tested: make check; uv run pytest tests/test_openclaw_cli.py tests/test_system_cli.py -q; make docs-test; make contract-test; standalone parser default probe.

Not-tested: Full Windows suite because current-master OpenCode tests retain unrelated Windows file-URI baseline failures.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>

@Teingi Teingi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Teingi
Teingi merged commit fc79efa into master Aug 25, 2026
12 checks passed
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.

docs: README integration lists are inconsistent across languages and omit OpenClaw/Pi

2 participants