Skip to content

docs: sync README files with latest repo state - #455

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates OSS code-map READMEs for the latest source-scoped search behavior.
  • Documents that profile/user-playbook/agent-playbook search paths carry source filters and how agent-playbook source matching is resolved.
  • Follows the parent repository policy in how_to_write_readme.md: concise, navigation-focused README changes only.

Repositories/submodules reviewed

  • ReflexioAI/reflexio (open_source/reflexio submodule)
  • Parent ReflexioAI/reflexio-enterprise reviewed separately in this scheduled run.

README files updated

  • reflexio/README.md
  • reflexio/server/README.md
  • reflexio/server/services/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/reflexio reflexio/README.md reflexio/server/README.md reflexio/server/services/README.md

Notes/Risks

  • README-only change.
  • open_source/reflexio/README.md is user-facing/public and was intentionally left untouched.

Summary by CodeRabbit

  • Documentation
    • Documented source-filter support for profile, user-playbook, and agent-playbook searches.
    • Clarified that agent-playbook results match playbooks linked to user playbooks from the requested source.
    • Updated unified search documentation to describe source-filter forwarding.
    • Clarified Unicode substring search behavior for queries containing non-ASCII letters or numbers.

@coderabbitai

coderabbitai Bot commented Aug 20, 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

Run ID: 8ef32708-2f0e-44b3-bd4f-9f5a234dfeb4

📥 Commits

Reviewing files that changed from the base of the PR and between 898de7a and af097d4.

📒 Files selected for processing (3)
  • reflexio/README.md
  • reflexio/server/README.md
  • reflexio/server/services/README.md

Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 4 reviews per hour.


📝 Walkthrough

Walkthrough

The README files document source-filter support for profile and playbook searches. Service documentation also updates the eligibility wording for bounded Unicode substring candidates.

Changes

Search documentation

Layer / File(s) Summary
Source-filter search documentation
reflexio/README.md, reflexio/server/README.md, reflexio/server/services/README.md
The documentation describes source filters for profile, user-playbook, and agent-playbook searches. Agent-playbook searches match linked user playbooks from the exact requested source.
Unicode search eligibility wording
reflexio/server/services/README.md
The storage documentation states that bounded Unicode substring candidates require at least one non-ASCII alphanumeric character.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to af097

This PR makes localized README updates describing existing source-scoped search behavior without changing runtime or product behavior; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

Suggested reviewers: guangyu-reflexio, yilu331

🚥 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 clearly identifies a documentation change that synchronizes README files with the repository state.
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-20260820

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