docs: add overview, contracts reference, service architecture pages - #2
Merged
jean-neiverth merged 4 commits intoAug 12, 2026
Conversation
…nd enhance subsolver guide - Add overview.md: problem statement (solver onboarding barrier), before/after contrast, how BYOS works, revenue model, consolidated rejection reasons, slashing policy summary - Add contracts.md: Escrow/Trampoline/TrampolineFactory interfaces (functions, events, errors), how BYOS interacts with each, key design decisions from contracts ADRs - Add service.md: two-listener model, async validation loop, proposal lifecycle, scoring, gas cut, persistence model, key design decisions from service ADRs - Enhance sub-solver integration guide: add explicit responsibility framing, API endpoint summary table, TypeScript reference implementation - Update vitepress sidebar/nav and README entry points
Cut triads, contrastive "X, not Y" padding, self-defending justifications, narrative flourishes, and unnecessary qualifiers. No facts removed.
jean-neiverth
marked this pull request as ready for review
August 12, 2026 14:26
jean-neiverth
merged commit Aug 12, 2026
7eff209
into
bleu:pedro/cow-1119-refactor-design-document-subsolver-guide
2 checks passed
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
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
Context
Gap analysis against expected documentation coverage identified these missing areas: