Skip to content

Fix .npmrc comment inconsistency and remove obsolete Docker network instructions#73

Merged
warengonzaga merged 2 commits intodevfrom
copilot/update-npmrc-comments-docs
Oct 10, 2025
Merged

Fix .npmrc comment inconsistency and remove obsolete Docker network instructions#73
warengonzaga merged 2 commits intodevfrom
copilot/update-npmrc-comments-docs

Conversation

Copy link
Contributor

Copilot AI commented Oct 10, 2025

Changes

This PR fixes two documentation/configuration inconsistencies:

1. Fixed .npmrc Comment Inconsistency

The comment on line 8 stated "Use shamefully-hoist for better compatibility with some tools" but the actual setting was shamefully-hoist=false, which disables hoisting. This was confusing and contradictory.

Updated the comment to accurately reflect the configuration:

-# Use shamefully-hoist for better compatibility with some tools
+# Disable shamefully-hoist to maintain strict dependency isolation
 shamefully-hoist=false

2. Removed Obsolete Docker Network Instructions

The installation documentation contained outdated instructions requiring users to manually create an external Docker network. However, docker-compose.yaml (lines 146-149) now configures the network as:

networks:
  unthread-integration-network:
    driver: bridge
    name: unthread-integration-network

This means Docker Compose automatically creates the bridge network when running docker compose up, making manual network creation unnecessary.

Removed from docs/installation.md:

  • Manual network creation command: docker network create unthread-integration-network
  • Obsolete error message: ERROR: Network unthread-integration-network declared as external, but could not be found
  • "IMPORTANT" warning about creating the external network first

Updated the documentation to:

  • Clarify that Docker Compose auto-creates the required network
  • Streamline the Docker setup instructions
  • Preserve the local development SSL validation caveat

Verification

✅ All type checks pass (pnpm type-check)
✅ All 737 tests pass (33 test files)
✅ No functional changes to code, only documentation/configuration clarity improvements

Impact

These changes improve developer experience by:

  • Making the .npmrc configuration self-documenting and clear
  • Simplifying Docker setup by removing unnecessary manual steps
  • Preventing confusion from obsolete error messages that users would never actually encounter
Original prompt

In .npmrc around lines 8 to 10 the comment says “Use shamefully-hoist for better
compatibility with some tools” but the setting is shamefully-hoist=false; either
set shamefully-hoist=true to match the comment (enabling hoisting) or update the
comment to accurately state that hoisting is disabled (e.g., “Disable
shamefully-hoist for compatibility reasons”); pick the intent you want and make
the comment and value consistent.

In docs/installation.md around lines 61 to 74, the reset instructions still
reference older external-network steps and an error snippet that are now
obsolete because docker-compose auto-creates the bridge network; remove the
external network creation/usage instructions and the error snippet entirely, and
update any surrounding text to simply state that docker compose will auto-create
the required network (keeping only the stop/remove volumes and docker compose up
-d commands and the local-dev caveat about -v), ensuring no leftover references
to external network configuration remain.

Changes should be PR to dev branch and use the dev branch as the base code.

Created from VS Code via the GitHub Pull Request extension.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com>
Copilot AI changed the title [WIP] Update .npmrc comments and installation instructions Fix .npmrc comment inconsistency and remove obsolete Docker network instructions Oct 10, 2025
Copilot AI requested a review from warengonzaga October 10, 2025 15:49
@warengonzaga warengonzaga added the deployment Deployment and infrastructure-related (Issues/PRs) label Oct 10, 2025
@warengonzaga warengonzaga marked this pull request as ready for review October 10, 2025 16:08
Copilot AI review requested due to automatic review settings October 10, 2025 16:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR addresses documentation and configuration inconsistencies by fixing misleading comments and removing obsolete setup instructions. The changes improve developer experience by making configuration self-documenting and simplifying Docker setup.

  • Fixed .npmrc comment to accurately reflect that hoisting is disabled for dependency isolation
  • Removed obsolete Docker network creation instructions that are no longer needed
  • Streamlined Docker setup documentation

Reviewed Changes

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

File Description
.npmrc Updated comment to accurately describe disabled shamefully-hoist setting
docs/installation.md Removed obsolete manual Docker network creation steps and updated instructions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@warengonzaga
Copy link
Member

@copilot what's the compatibility of this PR to dev branch?

Copy link
Contributor Author

Copilot AI commented Oct 10, 2025

@copilot what's the compatibility of this PR to dev branch?

This PR is fully compatible with the dev branch. It's based directly on commit 6754ba8 (the current HEAD of dev) and applies cleanly with no merge conflicts.

Both files changed (.npmrc and docs/installation.md) have the same issues in the dev branch that this PR fixes:

  • .npmrc has the same contradictory comment about shamefully-hoist
  • docs/installation.md has the same obsolete external network instructions

The PR can be merged into dev without any conflicts.

@warengonzaga warengonzaga merged commit 6765526 into dev Oct 10, 2025
5 checks passed
@warengonzaga warengonzaga deleted the copilot/update-npmrc-comments-docs branch October 10, 2025 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deployment Deployment and infrastructure-related (Issues/PRs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants