Skip to content

docs: clarify npm install purpose and correct Biome check command#666

Merged
JanPetterMG merged 5 commits into
mainfrom
copilot/update-development-docs
Jun 17, 2026
Merged

docs: clarify npm install purpose and correct Biome check command#666
JanPetterMG merged 5 commits into
mainfrom
copilot/update-development-docs

Conversation

Copilot AI commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Improves the Development wiki command guidance by clarifying the purpose of npm install in the webapp section and correcting an invalid Biome invocation.

Key changes

  • Webapp setup clarity
    • Added an explicit lead-in before dependency installation:
      • Install webapp dependencies:
  • Biome command correction
    • Replaced invalid npm biome check with the correct npx biome check to match existing command usage patterns.
cd webapp
npm install

cd webapp
npx biome check

Impact

  • Reduces ambiguity for contributors running webapp setup commands.
  • Prevents command failure caused by incorrect Biome invocation in the docs.
  • No runtime or behavior changes; documentation-only update.
Original prompt
Please apply the following diffs and create a pull request.
Once the PR is ready, give it a title based on the messages of the fixes being applied.

[{"message":"The command 'npm install' should explicitly specify what it installs or why it's needed. Consider adding a brief explanation like 'Install dependencies:' above this command block to clarify its purpose.","fixFiles":[{"filePath":"docs/wiki/Development.md","diff":"diff --git a/docs/wiki/Development.md b/docs/wiki/Development.md\n--- a/docs/wiki/Development.md\n+++ b/docs/wiki/Development.md\n@@ -14,6 +14,8 @@\n \n Biome is being used for linting and formatting of Typescript files.\n \n+Install webapp dependencies:\n+\n ```sh\n cd webapp\n npm install\n"}]},{"message":"The command 'npm biome check' is invalid. The correct command should use 'npx' to run Biome: 'npx biome check'. This follows the same pattern established in lines 33-34.","fixFiles":[{"filePath":"docs/wiki/Development.md","diff":"diff --git a/docs/wiki/Development.md b/docs/wiki/Development.md\n--- a/docs/wiki/Development.md\n+++ b/docs/wiki/Development.md\n@@ -23,7 +23,7 @@\n \n ```sh\n cd webapp\n-npm biome check\n+npx biome check\n ```\n \n Reformat or apply linter fixes to specific files:\n"}]}]

Copilot AI changed the title [WIP] Update Development.md with installation instructions and command correction docs: clarify npm install purpose and correct Biome check command Jun 17, 2026
Copilot AI requested a review from JanPetterMG June 17, 2026 19:36
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 17, 2026
@JanPetterMG JanPetterMG added this to the v2.5.1 milestone Jun 17, 2026
@JanPetterMG JanPetterMG marked this pull request as ready for review June 17, 2026 20:33
Copilot AI review requested due to automatic review settings June 17, 2026 20:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the developer documentation for the webapp to make the setup steps clearer and to fix an incorrect Biome command invocation.

Changes:

  • Added a short lead-in label before the npm install step to clarify its purpose.
  • Replaced the invalid npm biome check command with an npx biome check invocation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/wiki/Development.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 17, 2026 20:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread docs/wiki/Development.md Outdated
Comment thread docs/wiki/Development.md
Copilot AI review requested due to automatic review settings June 17, 2026 21:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@JanPetterMG JanPetterMG added this pull request to the merge queue Jun 17, 2026
Merged via the queue into main with commit 0c9b0b4 Jun 17, 2026
203 of 204 checks passed
@JanPetterMG JanPetterMG deleted the copilot/update-development-docs branch June 17, 2026 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants