Skip to content

docs: sync README files with latest repo state#154

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates code-map README references for reflexio/server/services/extraction/ after the latest main branch removed tools.py, plan.py, and invariants.py and retained the current resumable-agent helpers.
  • Keeps the changes concise and navigation-focused per how_to_write_readme.md.

Repositories/submodules reviewed

  • Parent: yyiilluu/reflexio-enterprise
  • Submodule: ReflexioAI/reflexio

README files updated

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

Validation

  • git diff --check
  • Practical relative Markdown link/path check for the updated README files

Notes/Risks

  • open_source/reflexio/README.md is the user-facing public README and was intentionally not restructured as a code map.
  • Parent repository submodule pointer was not committed; this PR is limited to the submodule repository README updates.

Summary by CodeRabbit

  • Documentation
    • Refined server documentation to clarify async extraction components and their roles in the extraction workflow.

@coderabbitai

coderabbitai Bot commented Jun 13, 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: 25796b41-4a3e-4f43-90f8-12094c1f7c7a

📥 Commits

Reviewing files that changed from the base of the PR and between 2cda749 and e6edcd8.

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

📝 Walkthrough

Walkthrough

This PR updates documentation across two README files in reflexio/server/ to reflect the actual async extraction subsystem. The main README's key-files listing now includes pending_tool_call_dispatch.py and outcome.py while removing references to tools.py, and the pattern description is clarified to explicitly mention pending tool-call dispatch as part of the extraction flow.

Changes

Async Extraction Documentation

Layer / File(s) Summary
Async extraction module documentation
reflexio/server/README.md, reflexio/server/services/README.md
Main README's key-files section and pattern description updated to list pending_tool_call_dispatch.py and outcome.py instead of tools.py and plan.py. Services README's async extraction file index likewise revised to reflect the current module set: resumable_agent.py, resume_scheduler.py, resume_worker.py, pending_tool_call_dispatch.py, prior_answer_search.py, agent_run_records.py, and outcome.py.

Possibly Related PRs

  • ReflexioAI/reflexio#135: Both PRs update server documentation to reflect the async extraction subsystem, specifically the listed async extraction modules.
  • ReflexioAI/reflexio#110: Both PRs are README-only updates to the reflection/async extraction documentation in the server directory.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


🐰 The docs now dance with truth,
Dispatch and outcome, proof!
No phantom modules hide,
Our async flow, clarified. 🌟

🚥 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' accurately summarizes the main changes—updating documentation to reflect the current repository structure after file removals.
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-20260613

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.

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