Skip to content

docs: sync README files with latest repo state#146

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates server code-map README navigation for new OSS-safe auth/billing hooks, usage metering helpers, local embedding daemon, embedding-service provider, and extraction token accounting.
  • Updates the services code-map README with the usage-metering boundary and the rule to keep enterprise billing types out of OSS services.

Repositories/submodules reviewed

  • Parent: yyiilluu/reflexio-enterprise (/root/reflexio-enterprise)
  • Submodule: ReflexioAI/reflexio (open_source/reflexio)

README files updated

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

Validation

  • Read and followed /root/reflexio-enterprise/how_to_write_readme.md.
  • Ran git diff --check in the submodule.
  • Ran a local README Markdown path/link existence check for the updated files.

Notes/Risks

  • open_source/reflexio/README.md was intentionally not restructured because it is the public/user-facing README excluded by the parent README policy.
  • Parent repository submodule pointer is not committed; this PR lives only in the submodule repository.

Summary by CodeRabbit

  • Documentation
    • Added documentation for OSS-safe Auth/Billing hook modules under Main Entry Points.
    • Documented embedding-service-related components and local embedding model support.
    • Added configuration guidance for embedding service options (concurrency and micro-batching).
    • Clarified billing usage metering processes and routing requirements.

@coderabbitai

coderabbitai Bot commented Jun 11, 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: 44309bf9-06f4-402c-9269-0664d41a31d8

📥 Commits

Reviewing files that changed from the base of the PR and between 31fc386 and 8f83d6e.

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

📝 Walkthrough

Walkthrough

This pull request updates two documentation files to clarify the server's OSS-safe billing architecture and new embedding service components. The main server README now documents Auth/Billing hook modules and expands the LLM Client section with local embedding daemon, provider, and token accounting details. The services README reinforces billing/usage metering flow rules and billing event routing requirements.

Changes

OSS-Safe Billing and Embedding Documentation

Layer / File(s) Summary
Main server documentation: entry points and LLM client components
reflexio/server/README.md
Main entry points now document OSS-safe Auth/Billing hook modules for enterprise overrides. LLM Client section expanded to list local embedding daemon, provider, and token accounting components, with new local embedding model support and configuration parameters for encode concurrency and micro-batching.
Service-level billing and usage metering rules
reflexio/server/services/README.md
Service documentation clarifies that generation and search endpoints route billing usage through root helpers (server/billing_meter.py, server/billing_signals.py), with canonical token counting and platform-LLM detection in signals and extraction token totals in accounting. Second rule reinforces that billing events must use root helpers rather than importing enterprise billing types in OSS services.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The docs now shine so clear and bright,
With billing rules and embedding might,
OSS-safe paths from root to leaf,
A rabbit hops with sweet relief! 🌱

🚥 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 describes the main change—updating multiple README files to reflect current repository state and new components.
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-20260611

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