Skip to content

docs: sync README files with latest repo state#227

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates Reflexio code-map READMEs for the latest server/model structure.
  • Documents the new provider-safe structured-output base, process-local operation limiter, storage retrieval-log split, and aggregation concurrency path.

Repositories/submodules reviewed

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

README files updated

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

Validation

  • git diff --check
  • python /root/.hermes/skills/github/scheduled-code-map-readme-maintenance/scripts/readme_link_check.py . reflexio/README.md reflexio/server/README.md reflexio/server/services/README.md reflexio/server/services/playbook/README.md

Notes/Risks

  • Updates follow /root/reflexio-enterprise/how_to_write_readme.md and are scoped to model-facing code-map READMEs.
  • open_source/reflexio/README.md was intentionally not rewritten because it is the public/user-facing README excluded by the policy.

Summary by CodeRabbit

  • Documentation
    • Expanded the README guides with clearer notes on structured AI outputs, including support for safer schema handling.
    • Added guidance for server operation limits, including how search, publish, and aggregation workloads are managed.
    • Updated service and playbook docs to reflect the latest storage layout and aggregation workflow details.

@coderabbitai

coderabbitai Bot commented Jun 25, 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: 6203f14c-1ae0-475d-ad1b-ad9e55da5bfa

📥 Commits

Reviewing files that changed from the base of the PR and between cc14ec4 and a1338e1.

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

📝 Walkthrough

Walkthrough

README files were updated to document StrictStructuredOutput, operation_limiter.py, playbook aggregation gating, and the storage_base/ split that now includes _retrieval_log.py.

Changes

Structured Output Documentation

Layer / File(s) Summary
Structured output references and rule
reflexio/README.md, reflexio/server/README.md
models/structured_output.py is added to the model and server docs, and StrictStructuredOutput is documented as the provider-safe path for discriminated-union response and tool schemas.

Operation Limiter Documentation

Layer / File(s) Summary
Operation limiter references and usage
reflexio/server/README.md, reflexio/server/services/README.md, reflexio/server/services/playbook/README.md
operation_limiter.py is documented as the process-local semaphore gate for search, publish, and aggregation, with default limits, overrides, logging, and the playbook aggregation path using the aggregation limit before embedding and LLM work.

Storage Domain Split

Layer / File(s) Summary
Retrieval log storage note
reflexio/server/README.md, reflexio/server/services/README.md
storage_base/ is updated to include _retrieval_log.py and the matching SQLite domain coverage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hopped through docs by moonlight's glow,
With StrictStructuredOutput helping flow.
operation_limiter kept the queues in tune,
And _retrieval_log sang under the moon.
🐇✨

🚥 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 summarizes the PR as a documentation sync across README files and is clearly related to the changes.
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-20260624

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