Skip to content

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

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Syncs OSS code-map READMEs with the latest server/service structure after pulling the submodule default branch.
  • Adds navigation pointers for the new unified-search exposure recorder boundary and canonical session outcome identity helpers.
  • Follows the parent repository's how_to_write_readme.md policy for concise, model-facing code-map READMEs.

Repositories/submodules reviewed

  • Parent: ReflexioAI/reflexio-enterprise
  • Submodules: ReflexioAI/reflexio, ReflexioAI/claude-smart

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

  • Documentation-only change.
  • open_source/reflexio/README.md (public user-facing README) was intentionally not restructured.
  • No parent submodule pointer update is included or required.

Summary by CodeRabbit

  • Documentation
    • Updated server documentation to describe governance-aware storage capabilities.
    • Documented canonical session-outcome identity and digest helpers.
    • Added guidance for the optional enterprise recording of user-playbook search exposure sets.
    • Clarified that search routes can synchronously record final exposure results.

@coderabbitai

coderabbitai Bot commented Aug 4, 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: e652c60e-57f4-494d-9638-a21da4363740

📥 Commits

Reviewing files that changed from the base of the PR and between eb88f44 and da98ddc.

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

📝 Walkthrough

Walkthrough

Documentation now describes optional unified-search exposure recording and canonical session-outcome identity helpers across the repository and server component maps.

Changes

Architecture documentation

Layer / File(s) Summary
Component map updates
reflexio/README.md, reflexio/server/README.md, reflexio/server/services/README.md
The documentation lists search_exposure.py as the optional unified-search exposure recorder and documents session_outcome_identity.py for canonical trajectory and immutable outcome digests.

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

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 and concisely describes the documentation updates to synchronize the 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-20260804

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