Repository navigation
docs(architecture): match the docs to the code - #136
Merged
Merged
Conversation
Audit of docs/architecture and AGENTS.md against the code: stale counts and member names, claims no code backs (statement_timeout read, messages read, bad-quality drop), the tpdefault rule, the converge database guard, owner sections for four key families, and history phrasing in living docs.
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.
Problem
An audit of
docs/architecture/*andAGENTS.mdagainst the code found about 70 places where the docs said something the code does not do. Some of them could mislead an operator or a developer:bench.mdcalled theconvergedrop "unconditional";Converge.RequireBenchDatabaserefuses any database without thesemiplot_prefix andsemiplot_provisioneditself.tpdefaulta fault; only rows witht >= current_dateare one, and no client code readstpdefault.statement_timeoutafter a failure, themessagestable, and a bad-quality sample being dropped.AGENTS.mdcalledCA1416a warning;TreatWarningsAsErrorsmakes it an error on both CI legs.What changed
statement_timeout,messages, bad quality (drawn as an ordinary point; no such code appeared in either measured archive),tpdefault, theconvergeguard.ArchiveFailureMapper.Maparms,ArchiveFaultkinds,TrendChartViewsubscriptions, the main window's view-side requests, container registrations, settings validation order, test class lists, brush consumers, the two two-minute container bounds, the export path's day reads and conversions.trend-interaction.mdgains three as-built notes (realtimedouble, theq = 32break, the archive layers).ui-text.mdgains owner sections for theMessagePanel*,Navigation*,Legend*andAbout*keys.README.mdlistspostgres-topology.md;sources.mddrops three never-cited markers and cites[FORUM:1454].PartitionScript.cs,SeededArchiveTests.cs,PartitionScriptTests.csandAppHost.cs.Left open, because the code does not settle them: which row a repeated extreme keeps in a coarse layer (
sources.mdandscada-archive.mddescribe two vendor builds), and the vendor claim in theLayerThinnercomment.Verification
*.md#anchorreference in the docs,AGENTS.mdand the code resolves to a heading; everysources.mdmarker is cited.terseclean on the four.csfiles.