docs(setup): drop stray "design" from dashboard requirement#3
Merged
Christian-Katzmann merged 1 commit intoMay 23, 2026
Conversation
The Setup Guide listed "Node.js/npm if rebuilding the dashboard design" under Requirements, while the canonical README lists "Node.js/npm if rebuilding the dashboard". The repo has no separate "dashboard design" artifact — the dashboard is the React app in dashboard-ui/, as that package's README makes explicit. Align setup.md with the README so first-time readers see the same requirement in both places. Co-authored-by: Christian Katzmann <123303433+Christian-Katzmann@users.noreply.github.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAligns the setup documentation’s dashboard build requirement text with the canonical wording in README by removing an extraneous word. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
What
Removes a stray word from
docs/setup.md. The line under Requirements:becomes:
Why
The same requirement appears in the canonical
README.mdwithout the trailing worddesign:There is no separate "dashboard design" artifact in the repo —
dashboard-ui/README.mdmakes this explicit ("React source for the local dashboard") and the npm scripts are simplynpm install/npm run dev/npm run buildagainst that package. The trailingdesigninsetup.mdlooks like an editing leftover; aligning it with the README removes a subtle inconsistency a first-time reader following the Setup guide will hit.How it was checked
README.mdline for the same requirement.dashboard-ui/README.mddescribes the dashboard as the React app and its build steps; no "design" subsystem exists alongside it.setup.mdare touched.Summary by Sourcery
Documentation: