docs: document pnpm flags in getting started page#2229
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe changes in this pull request enhance the documentation for the Changes
Assessment against linked issues
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@DeepaPrasanna is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
github-actions
bot
added
🕹️ 150 points
Documentation
|
Thank you for following the naming conventions for pull request titles! 🙏 |
![coderabbitai[bot]](proxy.php?url=https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
apps/docs/contributing/getting-started.mdx (1)
72-90: Great addition ofpnpm localcommand documentation!The new section effectively addresses the PR objectives by documenting the flags for the
pnpm localcommand. This information will be valuable for new developers. Here are a few suggestions to further improve the content:
Remove the space before the colon in the following lines:
- - `--service=<service>` : Specifies which part of the application to develop. + - `--service=<service>`: Specifies which part of the application to develop.Consider adjusting the indentation of the code blocks for consistency with the rest of the document. For example:
- ```bash - pnpm local [options] - ``` +```bash +pnpm local [options] +```Enhance the explanation of the
--serviceflag to clarify its purpose:- - `--service=<service>`: Specifies which part of the application to develop. The values are `dashboard`, `api`, or `www` + - `--service=<service>`: Specifies which part of the application to develop. This determines which environment files will be set up. The values are `dashboard`, `api`, or `www`🧰 Tools
🪛 LanguageTool
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...lable options: ---service=<service>: Specifies which part of the application...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...hboard,api, orwww---skip-env`: Skips the environment setup prompt if s...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- apps/docs/contributing/getting-started.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/contributing/getting-started.mdx
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...lable options: ---service=<service>: Specifies which part of the application...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...hboard,api, orwww---skip-env`: Skips the environment setup prompt if s...(UNLIKELY_OPENING_PUNCTUATION)
|
Hey @DeepaPrasanna, If @chronark approves can you also add the
in the test documentation? It is also one of the shortcuts to run tests for a single API route. |
|
Awarding DeepaPrasanna: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/DeepaPrasanna |
3 participants
What does this PR do?
Fixes #2227
Type of change
How should this be tested?
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
New Features
pnpm localcommand, allowing users to bypass manual input during setup.--serviceand--skip-envflags.Documentation