docs: truth up architecture, write-gating, and conventions - #310
Merged
Conversation
…generalization work
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
Close-out documentation sweep after the generalization work — every drifted passage found by auditing the docs against current code:
Pre-existing drift (predates this week):
pg_notify" and the api "runs a dedicatedLISTENconnection". Rewritten to the real design — the worker bumpsnudge_versionsin-transaction (now tagged with the touched tournaments), each api instance polls it through the pooled engine, no session-pinned connection anywhere. Diagram labels updated; the api bullet's stalemin=1 max=10replaced with theevent_mode-driven reality.tournament_creatorsgrants.LISTENER_ENABLEDdescriptions (README env table +app/config.pycomment) updated to "nudge poll loop + SSE fan-out"; a note records that the env var name predates Introduce PgBouncer connection pooling (DB conn ceiling) #196 and stays as deployment contract.Drift from this week's changes:
POST /v1/tournamentsno longer says "any authenticated user may" — it documents the creator allowlist and thecan_create_tournamentsgate; the PATCH bullet lists the real editable field set (rank_byincluded).NudgeVersion+TournamentCreatoradded to the entity groups, and two new convention bullets — Tournament write guards (creator allowlist, theSUPPORTED_TOURNAMENT_LEADERBOARD_IDSid-allowlist-not-name-check lesson, the two caps) and SSE nudge payload (tournament_idscontract and per-tick scoping semantics).Docs-only plus one comment; suite still 600 passed.
Deliberately NOT touched:
infra/README.md's cost-baseline paragraph still describes the retireddb-f1-microera — cost numbers should only be rewritten against billing actuals, so that's flagged for a future cost-audit pass rather than hand-edited here.