Skip to content

docs: sync README files with latest repo state#120

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

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

Conversation

@yyiilluu
Copy link
Copy Markdown
Contributor

@yyiilluu yyiilluu commented Jun 3, 2026

Summary

  • Syncs model-facing code-map READMEs with the latest Reflexio package layout.
  • Corrects stale navigation around lib/reflexio_lib.py, removes non-existent package data/db references, and documents current LLM/retrieval components.

Repositories/submodules reviewed

  • ReflexioAI/reflexio (open_source/reflexio submodule of yyiilluu/reflexio-enterprise)

README files updated

  • reflexio/README.md
  • reflexio/server/README.md

Validation

  • git diff --check
  • Local markdown link/path check for the updated README files

Notes/Risks

  • Updates follow how_to_write_readme.md: concise code-map/navigation changes only.
  • open_source/reflexio/README.md was intentionally not restructured because it is the public user-facing README.

Summary by CodeRabbit

  • Documentation
    • Refined project documentation structure with improved organization of lib and server components
    • Enhanced component diagrams and expanded key files listings for better clarity on architecture and entry points
    • Streamlined documentation to better guide users through the system's core services

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Root and server README files are restructured to document lib as a synchronous entry point, reorganize server components including a new retrieval relevance floor service, update LLM client architecture descriptions, and remove the legacy data section.

Changes

Documentation Restructuring

Layer / File(s) Summary
Root project documentation structure
reflexio/README.md
Table of contents and overview are refreshed to include lib and server explicitly. A new lib section documents the local synchronous entry point at lib/reflexio_lib.py and domain helpers. The entire ## data section is removed.
Root project server components documentation
reflexio/README.md
Server relationship diagram updates the Reflexio entry point path. Key Components descriptions are expanded for llm/ to highlight LiteLLM-based generation and embedding, and retrieval/ and search/ are added with their purposes.
Server README retrieval relevance floor component
reflexio/server/README.md
Table of contents adds Retrieval Relevance Floor entry. Services section lists the new retrieval/relevance_floor.py component. A new documentation section describes score floor application during searches and recommends using these helpers instead of duplicating threshold logic, with configuration in Config.retrieval_floor.
Server README LLM client documentation
reflexio/server/README.md
LLM Client Key files list expands to include llm_utils.py, model_defaults.py, embedding_service.py, provider adapters, and rerankers, while reducing emphasis on legacy direct client modules in favor of unified LiteLLMClient.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ReflexioAI/reflexio#113: Both PRs refresh reflexio/server/README.md to reorganize server architecture documentation and service routing guidance.
  • ReflexioAI/reflexio#110: Both PRs update server README Services and architecture documentation, with this PR's retrieval component additions as part of the broader docs reorganization effort.

Poem

🐰 With whiskers twitched and docs refined,
We map the lib and server's mind,
Retrieval floors now clearly drawn,
Old data gone—new paths are born! ✨

🚥 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 'docs: sync README files with latest repo state' directly describes the main change—updating documentation files to reflect current repository structure.
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-20260603

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@reflexio/README.md`:
- Line 86: Update the README's "Domain helpers" list to match the actual mixins
used by the Reflexio facade: add lib/_interactions.py and lib/_config.py to the
list so it mirrors the mixins declared in reflexio/lib/reflexio_lib.py (look for
the Reflexio class or its mixin imports in that file) and ensure the
comma-separated list includes those two entries.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c79e0208-4be2-4030-b1a7-36027d957cb3

📥 Commits

Reviewing files that changed from the base of the PR and between 27e41de and 1a1742c.

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

Comment thread reflexio/README.md
### Main Entry Point
- **Library**: `reflexio_lib.py` - `Reflexio` class
- **Library**: `lib/reflexio_lib.py` - `Reflexio` class
- **Domain helpers**: `lib/_profiles.py`, `lib/_user_playbook.py`, `lib/_agent_playbook.py`, `lib/_search.py`, `lib/_generation.py`, `lib/_reflection.py`, `lib/_dashboard.py`, `lib/_operations.py` - focused method groups mixed into `Reflexio`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

lib domain-helper list is incomplete and currently inaccurate.

Reflexio in reflexio/lib/reflexio_lib.py also mixes in lib/_interactions.py and lib/_config.py, but they’re missing here. Please add them so this code map stays in sync with the actual facade composition.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@reflexio/README.md` at line 86, Update the README's "Domain helpers" list to
match the actual mixins used by the Reflexio facade: add lib/_interactions.py
and lib/_config.py to the list so it mirrors the mixins declared in
reflexio/lib/reflexio_lib.py (look for the Reflexio class or its mixin imports
in that file) and ensure the comma-separated list includes those two entries.

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