Skip to content

docs(setup): drop stray "design" from dashboard requirement#3

Merged
Christian-Katzmann merged 1 commit into
Christian-Katzmann:mainfrom
QTpi-grl:docs/setup-align-dashboard-requirement
May 23, 2026
Merged

docs(setup): drop stray "design" from dashboard requirement#3
Christian-Katzmann merged 1 commit into
Christian-Katzmann:mainfrom
QTpi-grl:docs/setup-align-dashboard-requirement

Conversation

@QTpi-grl
Copy link
Copy Markdown
Contributor

@QTpi-grl QTpi-grl commented May 23, 2026

What

Removes a stray word from docs/setup.md. The line under Requirements:

Node.js/npm if rebuilding the dashboard design

becomes:

Node.js/npm if rebuilding the dashboard

Why

The same requirement appears in the canonical README.md without the trailing word design:

Node.js/npm if rebuilding the dashboard

There is no separate "dashboard design" artifact in the repo — dashboard-ui/README.md makes this explicit ("React source for the local dashboard") and the npm scripts are simply npm install / npm run dev / npm run build against that package. The trailing design in setup.md looks 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

  • Diffed against README.md line for the same requirement.
  • Verified dashboard-ui/README.md describes the dashboard as the React app and its build steps; no "design" subsystem exists alongside it.
  • GitHub's editor diff view confirms exactly one word removed; no other lines in setup.md are touched.
  • No code or build paths are affected.

Summary by Sourcery

Documentation:

  • Clarify the setup guide requirement to state Node.js/npm is needed when rebuilding the dashboard, matching the main README wording.

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>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 23, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Aligns the setup documentation’s dashboard build requirement text with the canonical wording in README by removing an extraneous word.

File-Level Changes

Change Details Files
Clarified the dashboard build requirement wording in the setup documentation to match README.
  • Updated the Requirements bullet describing when Node.js/npm is needed
  • Removed the trailing word that implied a separate dashboard design artifact
docs/setup.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Christian-Katzmann Christian-Katzmann merged commit c833465 into Christian-Katzmann:main May 23, 2026
4 checks passed
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.

2 participants