docs: explain what someguy does not do - #173
Open
lidel wants to merge 1 commit into
Open
Conversation
The docs covered how the routing and caching layers work, but not the choices behind them, so the reasoning lived in review threads. Someone reading only the code cannot tell a deliberate trade-off from an oversight, and two of these have already been broken by changes that looked harmless. - new response-streaming.md: the NDJSON contract, the timeout budget, and the two traps that silently defeat streaming - peer-address-caching.md gains a trade-offs section covering address-less records, detached lookups, the uncapped /peers path, and the absence of persistence - both frame the browser client as the constraint the API is tuned for - AGENTS.md leads with the contracts that must not break - cap and timeout values now reference their env vars rather than restating defaults that drift
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.
The docs covered how the caching and routing layers work, not the choices behind them, so the reasoning stayed in review threads.
Adds
response-streaming.md(the NDJSON contract, the timeout budget, and the two traps that silently defeat streaming) and a trade-offs section inpeer-address-caching.md. Both frame the browser client as the constraint someguy is tuned for.AGENTS.mdnow leads with the contracts that must not break.