[Docs] Improve and clarify npm link instructions in README (#999) #1082
Conversation
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
|
Thanks, @yashodipmore ! |
|
@M-DEV-1 will you review? |
M-DEV-1
reviewed
Jun 26, 2025
| # Expected output: | ||
| # node_modules/@sistent/sistent -> ../../../../../sistent | ||
| ```bash | ||
| npm ls -g --depth=0 |
There was a problem hiding this comment.
Hi @yashodipmore, wouldn't it be better to not specify the --depth flag here?
M-DEV-1
suggested changes
Jun 26, 2025
|
|
||
| ```bash | ||
| @layer5/sistent@x.y.z -> /path/to/your/sistent |
There was a problem hiding this comment.
Suggested change
| @layer5/sistent@x.y.z -> /path/to/your/sistent | |
| @sistent/sistent@x.y.z -> /path/to/your/sistent |
Comment on lines
-174
to
-175
| > [!NOTE] | ||
| > Avoid using `type any` in your code. Always specify explicit types to ensure type safety and maintainability. |
There was a problem hiding this comment.
Please revert this back, as this is a general tip, not related to local sistent forks.
|
@yashodipmore, the DCO check is failing, please signoff your commits. Ref: https://github.com/layer5io/sistent/pull/1082/checks?check_run_id=44296640731 |
M-DEV-1
reviewed
Jun 26, 2025
|
|
||
| 1. Create a link of your local Sistent fork | ||
| The `npm link` workflow allows contributors to test their local changes in Sistent within projects like Meshery UI without publishing the package to npm. It creates a symbolic link from the global `node_modules` to your development version of Sistent, enabling fast feedback during development. |
There was a problem hiding this comment.
This description, of the npm link command is helpful, but I'm not sure what is new in this change, except this description, and the extra tips in the end. Could you explain maybe why you felt this change was necessary?
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.
Notes for Reviewers
This PR fixes #999
This PR improves the
npm linkinstructions in the README by adding a detailed, developer-friendly, and accurate workflow for contributors to test their local Sistent fork within Meshery or other projects.Signed commits