Skip to content

docs: sync README files with latest repo state#88

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Syncs the claude_smart package code map with the latest multi-host architecture.
  • Documents OpenCode support alongside Claude Code and Codex paths, including the npm plugin bridge and isolated OpenCode extraction model override.

Repositories/submodules reviewed

  • Parent repository: ReflexioAI/reflexio-enterprise
  • Submodule updated in this PR: ReflexioAI/claude-smart (open_source/claude-smart)
  • Also reviewed: ReflexioAI/reflexio submodule (separate PR when applicable)

README files updated

  • plugin/src/README.md

Validation

  • git diff --check
  • python /root/.hermes/skills/github/scheduled-code-map-readme-maintenance/scripts/readme_link_check.py /root/reflexio-enterprise/open_source/claude-smart plugin/src/README.md

Notes/Risks

  • Updates follow /root/reflexio-enterprise/how_to_write_readme.md and are scoped to a model-facing code-map README.
  • User-facing root README content was left intact; it had already been updated upstream for OpenCode usage.
  • Parent submodule pointers should not be committed for this docs-only submodule PR.

Summary by CodeRabbit

  • Documentation
    • Updated the architecture and module overview to better reflect current CLI flows, hook handling, buffering, and host integration behavior.
    • Expanded the component list with additional runtime, session, context formatting, logging, and stall-notification details.
    • Revised the flow diagram and guidance to clarify routing, context injection, and key operational constraints.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 24913a64-ca4a-408b-b535-0a7c12cc243b

📥 Commits

Reviewing files that changed from the base of the PR and between a981338 and fd12bff.

📒 Files selected for processing (1)
  • plugin/src/README.md

📝 Walkthrough

Walkthrough

Updates plugin/src/README.md to revise the package description, expand the module inventory with new components, replace the architecture diagram to reflect updated routing/buffering/publishing flows, and add new constraints to the requirements section.

Changes

README Documentation Update

Layer / File(s) Summary
Module map, architecture, and constraints
plugin/src/README.md
Package description now includes CLI flows; module list gains host detection, ID handling, context query/formatting/citation helpers, stall banner, optimizer assistant, and structured logging. Architecture diagram replaced to show Claude Code/Codex/OpenCode routing. Requirements section adds CLAUDE_SMART_READ_ONLY enforcement and CLAUDE_SMART_OPENCODE_MODEL override constraint.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ReflexioAI/claude-smart#71: Updates the same plugin/src/README.md with an earlier revision of the claude_smart module map and architecture description.

Poem

🐇 A map of the warren, redrawn with care,
New tunnels for OpenCode added there,
The banners, the buffers, the skills we inject—
All noted in README, perfectly checked.
Hop hop, little doc, now the architecture's right! 🗺️

🚥 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 accurately describes a documentation sync, though it loosely says README files when only one README changed.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-readmes-20260629

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