Skip to content

Contributor and folder docs: use deprecated/ paths and say the Full Edition is deprecated (#6421) - #6535

Merged
erikdarlingdata merged 1 commit into
devfrom
fix/6421-contributor-docs-deprecated-paths
Oct 22, 2026
Merged

erikdarlingdata merged 1 commit into
devfrom
fix/6421-contributor-docs-deprecated-paths

Conversation

@erikdarlingdata

@erikdarlingdata erikdarlingdata commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

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 the deprecated/ paths. The Full Edition is marked deprecated where the file talks about it. The Full Dashboard architecture diagram is replaced with a short pointer to deprecated/Dashboard/README.md.
  • install/README.md and upgrades/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.
  • Nothing under deprecated/ was edited.

Corrected facts and evidence

  • The top-level Installer/, Installer.Core/ and Dashboard/ folders do not exist. deprecated/Installer, deprecated/Installer.Core and deprecated/Dashboard do (checked on disk; the same paths are in docs/building-from-source.md:22-24).
  • The Dashboard executable is PerformanceMonitorDashboard.exe, not Dashboard.exe: deprecated/Dashboard/Dashboard.csproj:8 (AssemblyName). CONTRIBUTING.md named the wrong file as well as the wrong folder. This is an extra wrong fact that I found.
  • Deprecation wording: 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:27 and README.md:29 (last builds are in the v3.2.0 release).
  • Dashboard/ServerTab.xaml* and Dashboard/Mcp/ are deprecated/Dashboard/ServerTab.xaml and deprecated/Dashboard/Mcp/*.cs (checked on disk). The MCP row now also lists Darling/PerformanceMonitor.Darling.Service/Mcp/, which exists.
  • upgrades/README.md said "Future upgrade folders will be added here". The newest folder is 3.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.0 and 1.1.0-to-1.2.0 do not exist). I left it as it is.
  • upgrades/README.md "The installer" now names deprecated/Installer/ and the Add Server dialog of the Full Dashboard. It reads config.installation_history: deprecated/Installer.Core/InstallationService.cs:1126-1166.
  • SECURITY.md scope 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 root README.md has no installation section that names security settings, so the link now goes to docs/permissions.md and docs/authentication.md.
  • install/README.md said the installer is Installer/ and that "Dashboard" installs the scripts. It now says deprecated/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.md is 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.
  • I did not remove the "Adding a New Full Edition Collector" steps. The 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.
  • The issue's last bullet is empty in the issue text. Nothing to check.

Not changed

  • The Lite diagram block in CONTRIBUTING.md and 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:3 and deprecated/Dashboard/README.md:3 link to ../Lite/README.md. From deprecated/ that resolves to deprecated/Lite/README.md, which does not exist. I did not touch them because they are under deprecated/. The link needs ../../Lite/README.md.

Tests

Markdown only. No test reads these four files (git grep for the file names in Lite.Tests, Darling/Darling.Tests, tools, .github finds only comments). No build was needed. The plain-English checker found no hits in the new text after I split one long SECURITY.md bullet. The remaining hits are older text that I did not rewrite, for example the em dashes in CONTRIBUTING.md lines 21, 29, 31, 37. Missing facts on its list are the old paths and Dashboard.exe, replaced on purpose. New facts are the deprecated/ and upgrades/ paths, PerformanceMonitorDashboard.exe, v3.2.0 and v3.3.0, all from the evidence above.

CHANGELOG entry

SECTION: Fixed
ENTRY:

@erikdarlingdata
erikdarlingdata marked this pull request as ready for review October 22, 2026 18:19
@erikdarlingdata
erikdarlingdata enabled auto-merge (squash) October 22, 2026 18:19

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: LGTM

Claims

  • VERIFIED — "The top-level Installer/, Installer.Core/ and Dashboard/ folders do not exist. deprecated/Installer, deprecated/Installer.Core and deprecated/Dashboard do" — confirmed on disk; deprecated/ contains Dashboard/, Installer/, Installer.Core/, matching docs/building-from-source.md:22-24.
  • VERIFIED — "The Dashboard executable is PerformanceMonitorDashboard.exe, not Dashboard.exe" — deprecated/Dashboard/Dashboard.csproj:8 sets <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:2207 has ## [3.3.0] - 2026-07-29 with "The Full Dashboard and the CLI Installer are retired", immediately followed by ## [3.2.0] - 2026-07-21 at line 2357.
  • VERIFIED — "The newest folder is 3.0.0-to-3.1.0" — ls upgrades/ confirms 3.0.0-to-3.1.0 is the highest-ending upgrade folder present.
  • VERIFIED — docs/permissions.md and docs/authentication.md exist and are reasonable targets for the SECURITY.md link that previously pointed at a root README.md with no security-configuration section.
  • VERIFIED — Darling/PerformanceMonitor.Darling.Service/Mcp and Lite/Mcp both exist, supporting the updated MCP row in CONTRIBUTING.md's complexity table.
  • VERIFIED — "deprecated/Installer/README.md:3 and deprecated/Dashboard/README.md:3 link 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 from deprecated/ resolve to nonexistent paths; this PR correctly leaves it untouched since it doesn't touch any file under deprecated/.
  • 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 for CONTRIBUTING.md/SECURITY.md/etc. as test fixture paths) but can't independently confirm the plain-English checker's tool output.

Riskiest lines

  1. 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).
  2. SECURITY.md (scope list and links to docs/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).
  3. upgrades/README.md (CHANGELOG link and "3.0.0-to-3.1.0" claim) — stale version pointers mislead someone tracing upgrade history — verified against ls upgrades/ and CHANGELOG.md contents; 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-only lists 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.md architecture-section rewrite and the install/README.md/upgrades/README.md blockquote notes, since link rendering and blockquote formatting can't be fully confirmed from raw diff text alone.

@erikdarlingdata
erikdarlingdata merged commit 18300b7 into dev Oct 22, 2026
38 of 59 checks passed
@erikdarlingdata
erikdarlingdata deleted the fix/6421-contributor-docs-deprecated-paths branch October 22, 2026 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant