doc: clarify which packages are dev dependencies. add collapsed instructions for yarn. #1022
+4
−3
Conversation
This file contains 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
…uctions for yarn. I've proposed splitting the runtime vs dev dependencies into separate lines as aligned with best practices. Additionally, I've added a default-collapsed section for yarn users.
|
|
timostamm
reviewed
Nov 29, 2024
There was a problem hiding this comment.
Thanks for the PR, David!
We want to keep the quickstart short, but one extra line to show which dependencies are built-time only is worth it 👍
I love the use of collapsed sections, but I'm afraid we'd rather keep it minimal, and only use npm. It's not that we don't like Yarn, but there's also pnpm, bun, and jsr.
per bufbuild#1022 (review) revert the sections leaving only the split between runtime/dev deps for npm
|
Thank you for the review @timostamm. I've reverted the yarn additions. This leaves the runtime/dev split updates and updates the sentence before it to assert the correct ordering of each. |
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.
I've proposed splitting the runtime vs dev dependencies into separate lines as aligned with best practices. Additionally, I've added a default-collapsed section for yarn users.