Skip to content

docs: note running the guard in front of eRPC - #23

Open
Logic769 wants to merge 1 commit into
yellowgram:mainfrom
Logic769:docs/erpc-compose-note
Open

Logic769 wants to merge 1 commit into
yellowgram:mainfrom
Logic769:docs/erpc-compose-note

Conversation

@Logic769

Copy link
Copy Markdown

Summary

Add a short note on running the guard in front of a reliability router (eRPC): the guard is a policy
layer, and eRPC handles multi-upstream failover/caching. The two compose instead of duplicating, so no
eRPC dependency is added and nothing is rebuilt.

Changes

  • docs/COMPOSE_ERPC.md (new): client/agent -> L2 Send Guard -> eRPC -> upstreams topology; the
    split of responsibilities; explicit "complement, do not rebuild"; note that L2SG_RPC_<NAME> should
    point at eRPC and L2SG_RPC_FALLBACK_<NAME> is simulation-only; a sample-grade, comment-annotated
    docker-compose sketch.
  • README.md: one-line pointer to docs/COMPOSE_ERPC.md in the Docker section.
    (The issue suggested linking from ARCHITECTURE.md, which was removed in the repo history rewrite, so
    the link lives in the README Docker section instead.)

Verification

  • npx vitest run → 2 failed | 684 passed | 2 skipped (40 files), identical to unmodified main.
    The two failures are pre-existing and unrelated to this docs-only change:
    tests/evaluation.harness.test.ts:120 (POSIX vs Windows path) and
    tests/guard/selectors.test.ts:419 (README quickstart parse; git CRLF on Windows).
  • Referenced targets exist: README.md (#configuration, #docker), policy.example.json,
    policy.agent.example.json, docker-compose.yml.
  • Docs-only: no src/, policy, or test files touched.

Closes #13

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.

[good first issue] Docs: Guard → eRPC compose note (complementary, no rebuild)

1 participant