Describe what each system does, not what it is written in - #17
Merged
Conversation
Document 09 now says a README opens with function and names its stack at the end. This page already ends with a Technology section; the component list did not follow the same rule. Four of the seven bullets led with an implementation detail. "A Kotlin limit order book" and "Black-Scholes valuation and Greeks in Kotlin" make the language the subject, and "a Spring Boot pipeline" makes the framework one — which tells a Java engineer scanning this page that it is someone else's stack before they reach the matching model or the cross-validation, the parts that would actually have interested them. position-ledger also claimed to publish VaR and PnL. It does not own those; risk-engine does, and that bullet now says so. What the ledger owns is the property worth leading with anyway: an execution and its position land in one Oracle transaction, so a replay cannot double-count and a crash cannot persist one without the other.
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.
Document 09 now says a README opens with function and names its stack at the end. This page already ends with a Technology section; the component list did not follow the same rule.
Language and framework leads removed
Four of seven bullets led with an implementation detail — "a Kotlin limit order book", "Black-Scholes valuation and Greeks in Kotlin", "authenticated Kotlin clients", "a Spring Boot pipeline". That makes the language the subject and tells a Java engineer scanning this page it is someone else's stack, before they reach the matching model, the single-writer design or the Strata cross-validation — the parts that would actually have interested them.
The design and measurement facts stay: LMAX Disruptor, JMH, scaled-integer prices. Those are evidence about the work, not a filter on who it is for.
position-ledger no longer claims VaR and PnL
It does not own those — risk-engine does, and its bullet now says so explicitly (Greeks, VaR, expected shortfall). What the ledger owns is the stronger claim anyway, and it now leads with it: an execution and its position land in one Oracle transaction, so a replayed execution cannot double-count and a crash cannot persist one without the other.
This is the org profile, so it is the first thing a visitor reads — worth a look before it lands.