Repository navigation
Contributor and folder docs: use deprecated/ paths and say the Full Edition is deprecated (#6421) - #6535
Merged
Conversation
erikdarlingdata
marked this pull request as ready for review
October 22, 2026 18:19
erikdarlingdata
enabled auto-merge (squash)
October 22, 2026 18:19
There was a problem hiding this comment.
Verdict: LGTM
Claims
- VERIFIED — "The top-level
Installer/,Installer.Core/andDashboard/folders do not exist.deprecated/Installer,deprecated/Installer.Coreanddeprecated/Dashboarddo" — confirmed on disk;deprecated/containsDashboard/,Installer/,Installer.Core/, matchingdocs/building-from-source.md:22-24. - VERIFIED — "The Dashboard executable is
PerformanceMonitorDashboard.exe, notDashboard.exe" —deprecated/Dashboard/Dashboard.csproj:8sets<AssemblyName>PerformanceMonitorDashboard</AssemblyName>. - VERIFIED — Deprecation wording and version claims ("last builds are in the v3.2.0 release", "No release since v3.3.0 includes them") —
CHANGELOG.md:2207has## [3.3.0] - 2026-07-29with "The Full Dashboard and the CLI Installer are retired", immediately followed by## [3.2.0] - 2026-07-21at line 2357. - VERIFIED — "The newest folder is
3.0.0-to-3.1.0" —ls upgrades/confirms3.0.0-to-3.1.0is the highest-ending upgrade folder present. - VERIFIED —
docs/permissions.mdanddocs/authentication.mdexist and are reasonable targets for theSECURITY.mdlink that previously pointed at a rootREADME.mdwith no security-configuration section. - VERIFIED —
Darling/PerformanceMonitor.Darling.Service/McpandLite/Mcpboth exist, supporting the updated MCP row in CONTRIBUTING.md's complexity table. - VERIFIED — "
deprecated/Installer/README.md:3anddeprecated/Dashboard/README.md:3link to../Lite/README.md... which does not exist" (flagged in the PR body as left alone because it's outside the four changed files) — confirmed both files link to../Lite/README.md/../Darling/README.md, which fromdeprecated/resolve to nonexistent paths; this PR correctly leaves it untouched since it doesn't touch any file underdeprecated/. - UNVERIFIED — "No test reads these four files" (git grep claim) and "The plain-English checker found no hits in the new text" — these describe commands run during authoring; a read-only tree review can rerun the same
git grep(consistent with no hits found forCONTRIBUTING.md/SECURITY.md/etc. as test fixture paths) but can't independently confirm the plain-English checker's tool output.
Riskiest lines
CONTRIBUTING.md(deprecated/ path table) — a wrong path here misdirects contributors trying to build the Full Dashboard — not a behaviour-tested surface; this is prose, and no test fails on a stale doc path. UNCOVERED (docs-only, no behaviour test applies).SECURITY.md(scope list and links todocs/permissions.md/docs/authentication.md) — a broken link here degrades a security researcher's intake path — verified both targets exist on disk; no behaviour test applies. UNCOVERED (docs-only).upgrades/README.md(CHANGELOG link and "3.0.0-to-3.1.0" claim) — stale version pointers mislead someone tracing upgrade history — verified againstls upgrades/andCHANGELOG.mdcontents; no behaviour test applies. UNCOVERED (docs-only).
Traps near this diff
- "Lite and Darling ship in parity... a fix to one SKU's reader, tool, alert or description without the counterpart's is a finding" — does not apply. This diff touches only
CONTRIBUTING.md,SECURITY.md,install/README.md,upgrades/README.md; it makes no change to Lite or Darling code, readers, tools, alerts, or MCP surfaces (gh pr diff 6535 --name-onlylists only these four docs files), so there is no SKU-paired behavior to keep in parity. - No other trap (SQL, collectors/deltas, analysis, alerting, storage/MCP, tests/censuses, workflows/CI, repository mechanics) is near this diff — all are keyed to code or CI shapes this change does not touch.
Divergence (blind read vs PR body)
None — the body's account matches the diff on every claim graded above, including its explicit disclosure of the ../Lite/README.md broken-link issue it chose not to fix because it lives in files outside this PR's scope.
Reviewer checklist
- Spot-check the rendered Markdown (GitHub preview) for the new
CONTRIBUTING.mdarchitecture-section rewrite and theinstall/README.md/upgrades/README.mdblockquote notes, since link rendering and blockquote formatting can't be fully confirmed from raw diff text alone.
erikdarlingdata
deleted the
fix/6421-contributor-docs-deprecated-paths
branch
October 22, 2026 22:00
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.
Claude posting for Erik Darling.
Fixes #6421.
What changes
CONTRIBUTING.md: the Full Edition folder table, the run steps, the architecture section, the contribution table and two headings now use thedeprecated/paths. The Full Edition is marked deprecated where the file talks about it. The Full Dashboard architecture diagram is replaced with a short pointer todeprecated/Dashboard/README.md.install/README.mdandupgrades/README.md: a first-line note that the Full Edition is deprecated, and the installer paths fixed.SECURITY.md: the scope list matches what ships, and the security link points at real documents.deprecated/was edited.Corrected facts and evidence
Installer/,Installer.Core/andDashboard/folders do not exist.deprecated/Installer,deprecated/Installer.Coreanddeprecated/Dashboarddo (checked on disk; the same paths are indocs/building-from-source.md:22-24).PerformanceMonitorDashboard.exe, notDashboard.exe:deprecated/Dashboard/Dashboard.csproj:8(AssemblyName).CONTRIBUTING.mdnamed the wrong file as well as the wrong folder. This is an extra wrong fact that I found.deprecated/Installer/README.md:3(not in release assets since v3.3.0, supported for existing users, remains buildable, new deployments use Lite or Darling),deprecated/Dashboard/README.md:3,README.md:27andREADME.md:29(last builds are in the v3.2.0 release).Dashboard/ServerTab.xaml*andDashboard/Mcp/aredeprecated/Dashboard/ServerTab.xamlanddeprecated/Dashboard/Mcp/*.cs(checked on disk). The MCP row now also listsDarling/PerformanceMonitor.Darling.Service/Mcp/, which exists.upgrades/README.mdsaid "Future upgrade folders will be added here". The newest folder is3.0.0-to-3.1.0(ls upgrades), and the version history stopped at 2.0.0 while folders go to 3.1.0. The note now says so and points to the CHANGELOG. The tree under "Structure" is an example, not a listing (1.0.0-to-1.1.0and1.1.0-to-1.2.0do not exist). I left it as it is.upgrades/README.md"The installer" now namesdeprecated/Installer/and the Add Server dialog of the Full Dashboard. It readsconfig.installation_history:deprecated/Installer.Core/InstallationService.cs:1126-1166.SECURITY.mdscope listed "Installer utilities" and "Dashboard". It now lists Lite and its embedded MCP server, Darling (service, viewer, MCP server, web dashboard:Darling/PerformanceMonitor.Darling.Service/DarlingWebEndpoints.cs,.../Mcp/), the shared libraries, and the deprecated Full Edition, which is still supported for existing users. The rootREADME.mdhas no installation section that names security settings, so the link now goes todocs/permissions.mdanddocs/authentication.md.install/README.mdsaid the installer isInstaller/and that "Dashboard" installs the scripts. It now saysdeprecated/Installer/and the Full Dashboard's Add Server dialog (deprecated/Dashboard/README.md, "Install" section).Claims in the issue that I left alone or adjusted
CONTRIBUTING.mdis 32 KB and most of the architecture section describes the deprecated product": the architecture section had one Full Dashboard diagram, then Lite and Darling diagrams. Only the Full Dashboard part is cut. The Lite and Darling parts are current and stay.install/scripts they name still exist and were changed on 2026-10-11 (git log -- install), so the steps still hold for the supported Full Edition.Not changed
CONTRIBUTING.mdand the Darling sections: spot-checked that each named file exists (Lite/Database/Schema.cs,Lite/Services/ScheduleManager.cs,ArchiveService.cs,RetentionService.cs,LocalDataService.*.cs,DarlingCollectorRunner.cs,PgMigrations.cs,TimescaleSupport.cs,ViewerDataService.cs). All exist.deprecated/Installer/README.md:3anddeprecated/Dashboard/README.md:3link to../Lite/README.md. Fromdeprecated/that resolves todeprecated/Lite/README.md, which does not exist. I did not touch them because they are underdeprecated/. The link needs../../Lite/README.md.Tests
Markdown only. No test reads these four files (
git grepfor the file names inLite.Tests,Darling/Darling.Tests,tools,.githubfinds only comments). No build was needed. The plain-English checker found no hits in the new text after I split one longSECURITY.mdbullet. The remaining hits are older text that I did not rewrite, for example the em dashes inCONTRIBUTING.mdlines 21, 29, 31, 37. Missing facts on its list are the old paths andDashboard.exe, replaced on purpose. New facts are thedeprecated/andupgrades/paths,PerformanceMonitorDashboard.exe, v3.2.0 and v3.3.0, all from the evidence above.CHANGELOG entry
SECTION: Fixed
ENTRY:
deprecated/paths and say the Full Edition is deprecated ([Contributor and folder docs: use deprecated/ paths and say the Full Edition is deprecated (#6421) #6535]) -CONTRIBUTING.mdnamed top-levelInstaller/,Installer.Core/andDashboard/folders and the wrongDashboard.exefile. These are nowdeprecated/Installer/,deprecated/Installer.Core/,deprecated/Dashboard/andPerformanceMonitorDashboard.exe.install/README.md,upgrades/README.mdandSECURITY.mdgot the same fixes, andSECURITY.mdnow lists what ships (Lite, Darling, MCP, web dashboard).REF:
[Contributor and folder docs: use deprecated/ paths and say the Full Edition is deprecated (#6421) #6535]: Contributor and folder docs: use deprecated/ paths and say the Full Edition is deprecated (#6421) #6535