Skip to content

docs: sync README files with latest repo state#252

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

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

Conversation

@yyiilluu

@yyiilluu yyiilluu commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Syncs model-facing server code-map READMEs with the latest Reflexio OSS service structure.
  • Adds a new governance service code map for export/erasure, audit, purge, and privacy-safe reference workflows.
  • Updates API/service maps for learning provenance, governance storage, and retrieval recency helpers.

Repositories/submodules reviewed

  • Parent repository: ReflexioAI/reflexio-enterprise
  • Submodule updated in this PR: ReflexioAI/reflexio (open_source/reflexio)
  • Also reviewed: ReflexioAI/claude-smart submodule (separate PR when applicable)

README files updated

  • reflexio/server/README.md
  • reflexio/server/api_endpoints/README.md
  • reflexio/server/services/README.md
  • reflexio/server/services/governance/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/server/README.md reflexio/server/api_endpoints/README.md reflexio/server/services/README.md reflexio/server/services/governance/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 restructured because it is the user-facing public README excluded by the policy.
  • Parent submodule pointers should not be committed for this docs-only submodule PR.

Summary by CodeRabbit

  • Documentation
    • Expanded API and services documentation to include learning provenance support, with a new endpoint reference for retrieving provenance.
    • Added governance service documentation covering export and erasure workflows, audit tracking, and privacy-safe handling.
    • Updated service and storage indexes to reflect the new governance area and broader retrieval/storage organization.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation-only update: adds a new reflexio/server/services/governance/README.md describing the governance service orchestration layer, and updates three existing READMEs to reflect the new governance module, a renamed/expanded API endpoint group (Search/stats/provenance with POST /api/get_learning_provenance), storage domain splits (_governance.py), and a new See Also link.

Changes

Governance & provenance documentation

Layer / File(s) Summary
New governance service README
reflexio/server/services/governance/README.md
Introduces governance service docs: entry points (service.py, subject_refs.py), responsibilities (audit events, idempotent purge tracking, privacy-safe hashed references), orchestration flow, and key contracts.
Server, services, and api_endpoints README updates
reflexio/server/README.md, reflexio/server/services/README.md, reflexio/server/api_endpoints/README.md
Renames endpoint group to "Search/stats/provenance" and adds POST /api/get_learning_provenance; adds governance/ service entry and retrieval/ to services index; adds _governance.py domain split to storage entries; adds provenance bullet to api_endpoints architecture pattern; adds governance README link to See Also.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ReflexioAI/reflexio#135: Updates the same documentation files (reflexio/server/README.md, api_endpoints/README.md, services/README.md) using the same table/endpoint-architecture framing.

Poem

🐇 A governance README hops into view,
With provenance endpoints shiny and new.
The storage splits neatly by domain,
And audit trails follow like drops of rain.
Every doc updated, every link in place—
This bunny approves at a rapid pace! 🌿

🚥 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 docs-only README sync and matches the main change in this PR.
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-20260629

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
reflexio/server/services/governance/README.md (1)

21-27: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Add language specifier to fenced code block.

The architecture diagram code block is missing a language specifier. Add text or plaintext after the opening backticks to satisfy markdownlint and improve rendering consistency.

- ```
+ ```text
 GovernanceService
   -> storage.begin_purge_operation / prepare_governance_erase_targets
   -> storage.apply_governance_user_data_delete
   -> storage.apply_governance_agent_playbook_rebuild
   -> storage.complete_purge_operation_with_audit

<details>
<summary>🤖 Prompt for AI Agents</summary>

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/server/services/governance/README.md around lines 21 - 27, Add a
language specifier to the fenced architecture diagram block in the
GovernanceService section so markdownlint accepts it and rendering stays
consistent; update the opening fence for the code block containing
GovernanceService and its storage steps to use text or plaintext while keeping
the diagram content unchanged.


</details>

<!-- cr-comment:v1:c9fd69fd2df361e8259e3ab6 -->

_Source: Linters/SAST tools_

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

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

Nitpick comments:
In @reflexio/server/services/governance/README.md:

  • Around line 21-27: Add a language specifier to the fenced architecture diagram
    block in the GovernanceService section so markdownlint accepts it and rendering
    stays consistent; update the opening fence for the code block containing
    GovernanceService and its storage steps to use text or plaintext while keeping
    the diagram content unchanged.

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro Plus

**Run ID**: `51e4d47c-697c-4585-a615-1192634ceea6`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 4554913daaa51222f8f2f466b660a980fa6a0a15 and ad7d43198514bb0142a09557cae8c081c195c9df.

</details>

<details>
<summary>📒 Files selected for processing (4)</summary>

* `reflexio/server/README.md`
* `reflexio/server/api_endpoints/README.md`
* `reflexio/server/services/README.md`
* `reflexio/server/services/governance/README.md`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

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