docs: add design rationale documents for key architectural decisions#129
Merged
raffaelschneider merged 2 commits intozentinelproxy:mainfrom Mar 10, 2026
Merged
Conversation
Add five documents under doc/design/ explaining why Zentinel made its core architectural choices, what alternatives were considered, trade-offs accepted, and when each decision might be revisited: - why-pingora.md: Pingora as the proxy foundation - why-external-agents.md: external processes over embedded plugins - why-kdl.md: KDL over YAML/TOML/JSON for configuration - why-explicit-config.md: explicit config with fail-closed defaults - why-bounded-resources.md: hard limits on all resources Closes zentinelproxy#125
Feature requests now require confirming that the proposal does not conflict with existing architectural decisions documented in doc/design/. PR template adds the same checkpoint to the checklist.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
doc/design/explaining why key architectural decisions were made, not just what they arewhy-pingora.md,why-external-agents.md,why-kdl.md,why-explicit-config.md,why-bounded-resources.mdCloses #125
Test plan