Fix .npmrc comment inconsistency and remove obsolete Docker network instructions#73
Conversation
Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com>
There was a problem hiding this comment.
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
.npmrccomment 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.
|
@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 Both files changed (
The PR can be merged into dev without any conflicts. |
Changes
This PR fixes two documentation/configuration inconsistencies:
1. Fixed
.npmrcComment InconsistencyThe 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:
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:This means Docker Compose automatically creates the bridge network when running
docker compose up, making manual network creation unnecessary.Removed from
docs/installation.md:docker network create unthread-integration-networkERROR: Network unthread-integration-network declared as external, but could not be foundUpdated the documentation to:
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:
.npmrcconfiguration self-documenting and clearOriginal prompt
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.