Skip to content

Contributor and folder docs still send readers to the old Dashboard and Installer paths #6421

Closed

Description

@erikdarlingdata

Claude posting for Erik Darling.

Who hits it: New contributors, and anyone who opens install/ or upgrades/ on GitHub.

Where: CONTRIBUTING.md:19-30, 73-92, 243-258, install/README.md:3, upgrades/README.md, SECURITY.md:21-25.

What is wrong or hard:

  • CONTRIBUTING.md says the repository holds "three editions" and lists Installer/, Installer.Core/ and Dashboard/ as live folders. They are under deprecated/. It tells the reader to run Dashboard/bin/Debug/net10.0-windows/Dashboard.exe and to edit Dashboard/ServerTab.xaml*. The build commands further up use the right deprecated/ paths, so the file disagrees with itself. It is 32 KB, and most of the architecture section describes the deprecated product.
  • install/README.md says the CLI installer is Installer/ and the Dashboard installs the scripts. upgrades/README.md has a 2.0.0 era version history and no sign that the whole folder belongs to the deprecated edition.
  • SECURITY.md lists "Installer utilities" and "Dashboard" in scope and says to see the installation documentation in the root README, which no longer describes an installer.

Evidence:
docs/building-from-source.md uses the correct deprecated/Dashboard and deprecated/Installer paths. git ls-files shows no top-level Installer/ or Dashboard/ folder.

Proposed fix:
Fix the paths in CONTRIBUTING.md, shorten the Dashboard architecture to a pointer, and say once at the top that these folders are deprecated. Add a first-line note to install/README.md and upgrades/README.md. Update SECURITY.md scope to match what ships (Lite, Darling service and viewer, MCP, web dashboard).

On erikdarling.com? No.

Target: 3.12.

Activity

  1. added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    owner:pm-worker-helperLaptop helper session: click-test fixes. Other sessions leave these alone.
    3.12Planned for 3.12: install and admin friendliness, docs correctness and readability
    on Oct 22, 2026
  2. erikdarlingdata commented on Oct 22, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling.

    Correction after checking this issue against current dev:

    • Minor: the SECURITY.md point says the root README no longer describes an installer. It does: README.md line 32 says "Run the installer" for the Lite Setup.exe. The scope list in SECURITY.md ("Installer utilities", "Dashboard and Lite WPF applications") is still out of date and should name what ships now: Lite, the Darling service and viewer, MCP and the web dashboard.

    The Installer/ and Dashboard/ path problems are confirmed.

  3. added and removed
    owner:pm-worker-helperLaptop helper session: click-test fixes. Other sessions leave these alone.
    on Oct 22, 2026
  4. erikdarlingdata commented on Oct 23, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling.

    Fixed on dev by #6535 (merged; its body says Fixes #6421). Dev merges don't close issues on their own, so closing it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12Planned for 3.12: install and admin friendliness, docs correctness and readabilitybugSomething isn't workingdocumentationImprovements or additions to documentationowner:pm-worker-coordinatorLaptop coordinator session

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions