docs: add co-located README docs for services/* modules#961
Merged
bmc08gt merged 1 commit intoJun 22, 2026
Conversation
Module-level documentation for the four service modules, at catalog + internals depth, cross-linked to the architecture suite: - services/opencode/README.md — OCP client: 5 public controllers, the SubmitIntent bidirectional handshake (IntentExecutor + BidirectionalStream Reference, with a sequence diagram), intents/actions, the solana/programs instruction builders, transactors, swaps, and exchange/VerifiedState; DI + the ed25519.shadow plugin; an "adding an intent" checklist. - services/flipcash/README.md — Flipcash backend client: the 14 controllers, models/UserManager/AuthState, signing + request lifecycle, event streaming, DI/channels, and an "adding an RPC" checklist. - services/opencode-compose/README.md — LocalExchange + ExchangeStub bindings. - services/flipcash-compose/README.md — intended Compose-bindings layer, explicitly flagged as a shell (no src yet). Adds a "Module-level docs" pointer from 04-networking to the four READMEs. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> Claude-Session: https://claude.ai/code/session_01JRVfsXp4HDrDMy7Pbmw9fD
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
2 participants
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.
Module-level documentation for the four service modules, at catalog + internals depth, cross-linked to the architecture suite:
Adds a "Module-level docs" pointer from 04-networking to the four READMEs.