Skip to content

docs(readme): update Architecture tree post-sentrix-proto migration#33

Merged
satyakwok merged 1 commit into
mainfrom
chore/polish-readme-truth
May 13, 2026
Merged

docs(readme): update Architecture tree post-sentrix-proto migration#33
satyakwok merged 1 commit into
mainfrom
chore/polish-readme-truth

Conversation

@satyakwok
Copy link
Copy Markdown
Member

@satyakwok satyakwok commented May 13, 2026

10 of N in the all-READMEs polish sweep. Architecture diagram still showed proto/sentrix.proto → build.rs / tonic-build → src/grpc/pb but PR #32 dropped local proto + build.rs and migrated to the published sentrix-proto crate from crates.io. Updated diagram + added the wasm-specific default-features = false note.

Summary by CodeRabbit

  • Documentation
    • Updated README architecture diagrams and documentation to accurately reflect the current system structure and design. The documentation now clearly illustrates how system components are organized and integrated throughout the codebase, providing improved visibility into the overall application architecture, component relationships and interdependencies, and system design patterns used in the project.

Review Change Stack

The proto schema was extracted into a standalone `sentrix-proto` crate
on crates.io (chain repo PR #667) and this app migrated to consume it
in PR #32 — local `proto/` + `build.rs` + tonic codegen are gone.

The Architecture diagram still showed:
  proto/sentrix.proto → build.rs / tonic-build → src/grpc/pb

Updated to reflect the current path:
  sentrix-proto crate → re-exported as `pb` in src/grpc/mod.rs

Includes the wasm-specific `default-features = false` note since the
transport feature gate is the whole reason that migration shipped.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

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: 27bee52a-e8ba-4ce7-965d-071ad1ab4ce4

📥 Commits

Reviewing files that changed from the base of the PR and between 3165b61 and 1b1423d.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR updates the README architecture diagram to reflect a change in how protocol buffer definitions are sourced. Proto definitions now come from an external sentrix-proto crate as the single source of truth (configured with default-features = false for WebAssembly support), replacing the previous local code generation pipeline. The src/grpc/pb module consumes prost types and tonic client stubs directly from this external crate, and src/grpc/mod.rs re-exports these as pb.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Sentriscloud/sentrix-explorer-v2#32: Implements the migration to consume proto definitions from the sentrix-proto external crate, which this PR documents in the README architecture diagram.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing the required Template sections (Summary and Test plan). While it provides context about the change, it does not follow the specified repository template structure. Restructure the description to match the template: add a clear Summary section (1-3 sentences) and include a Test plan section with a checklist of verification steps.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: updating the Architecture documentation in the README after the sentrix-proto migration, which aligns with the changeset.
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 chore/polish-readme-truth

Comment @coderabbitai help to get the list of available commands and usage tips.

@satyakwok satyakwok merged commit 1f74071 into main May 13, 2026
11 checks passed
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