Skip to content

docs: sync README files with latest repo state#207

Open
yyiilluu wants to merge 1 commit into
mainfrom
docs/sync-readmes-20260622
Open

docs: sync README files with latest repo state#207
yyiilluu wants to merge 1 commit into
mainfrom
docs/sync-readmes-20260622

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes a broken relative link from reflexio/integrations/openclaw/README.md to an internal design spec that is not packaged in the public repository.
  • Points readers to the shipped local plugin README/contract instead.
  • Follows the code-map README guidance in the parent how_to_write_readme.md: concise, navigation-focused, and limited to a materially broken path.

Repositories/submodules reviewed

  • ReflexioAI/reflexio submodule repository

README files updated

  • reflexio/integrations/openclaw/README.md

Validation

  • git diff --check
  • Local README link/path check for the changed README

Notes/Risks

  • This PR does not update the parent repository's submodule pointer; the parent docs fix is in a separate PR.

Summary by CodeRabbit

  • Documentation
    • Updated README to clarify where to find plugin behavior documentation, directing users to the README and public plugin contract as the authoritative sources.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 31bcafa7-b185-4d4f-b6d9-72a0d3be766c

📥 Commits

Reviewing files that changed from the base of the PR and between 95bae7d and 2854c9b.

📒 Files selected for processing (1)
  • reflexio/integrations/openclaw/README.md

📝 Walkthrough

Walkthrough

Lines 77–79 of the OpenClaw integration README are updated to remove a pointer to an internal design document and replace it with a note directing readers to the public README and plugin/README.md as the authoritative plugin contract sources, stating that internal design notes are not included in the public repository.

Changes

OpenClaw README documentation pointer update

Layer / File(s) Summary
Remove internal doc link
reflexio/integrations/openclaw/README.md
Replaces the "full design lives in …" link to an internal spec with a statement that internal design notes are not packaged in the public repo and that plugin/README.md is the public plugin contract reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • ReflexioAI/reflexio#110: Also a documentation-only change that repoints OpenClaw integration references, directly touching the same OpenClaw README ecosystem that this PR edits.

Poem

A link to the shadows? Not here, not today!
The rabbit has tidied the docs on the way.
The plugin contract is public and clear,
No internal scrolls for the open frontier.
🐇✨ The README now points where the light holds sway!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title refers to syncing README files, which directly relates to the changeset that updates the openclaw README documentation. However, it is somewhat generic and could apply to many documentation updates, making it less specific about the actual issue being fixed (removing a broken link).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-readmes-20260622

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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