-
Notifications
You must be signed in to change notification settings - Fork 57
chore: update development environment docs #336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: update development environment docs #336
Conversation
WalkthroughReplaced Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Notes:
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)_docs/development-environment.md44-44: Link fragments should be valid (MD051, link-fragments) 🔇 Additional comments (10)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
_docs/development-environment.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
_docs/development-environment.md
[grammar] ~43-~43: There might be a mistake here.
Context: ...work/provider/blob/main/_run) directory. Commands are implemented as...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... configuration variants, each presented as directory within [_run](https://github....
(QB_NEW_EN)
[grammar] ~93-~93: Ensure spelling is correct
Context: ...ider/blob/main/_run/common.mk#L38..L43): They keys are assigned to the targets and un...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
_docs/development-environment.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
_docs/development-environment.md
[grammar] ~43-~43: There might be a mistake here.
Context: ...work/provider/blob/main/_run) directory. Commands are implemented as...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... configuration variants, each presented as directory within [_run](https://github....
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...ider/blob/main/_run/common.mk#L38..L43): The keys are assigned to the targets and...
(QB_NEW_EN)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
_docs/development-environment.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
_docs/development-environment.md
[grammar] ~93-~93: There might be a mistake here.
Context: ...ider/blob/main/_run/common.mk#L38..L43): The keys are assigned to the targets and...
(QB_NEW_EN)
030eb40 to
12bc6a2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
🧹 Nitpick comments (3)
_docs/development-environment.md (3)
49-50: Typo: minukube → minikube.-- minukube +- minikube
227-229: Pluralize “terminal”.-This runbook requires two terminal +This runbook requires two terminals
5-5: Remove editorial note and tighten wording.The parenthetical "(Better explanation?)" should be removed; suggest clearer phrasing.
-The provider repo elected as placeholder for all the scripts as it depends on the `node` repo (Better explanation?) +The provider repository hosts the shared development scripts because it depends on the `node` repository.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
_docs/development-environment.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
_docs/development-environment.md
[grammar] ~93-~93: There might be a mistake here.
Context: ...ider/blob/main/_run/common.mk#L38..L43): The keys are assigned to the targets and...
(QB_NEW_EN)
12bc6a2 to
166897f
Compare
166897f to
24848ed
Compare
|
Rebased against latest changes to Note: most of the updates are responses to nitpicks from CodeRabbit. The original intention was just to update a few instructions to make it easier for future engineers onboarding to the platform. Apologies if this comes off as my own style of nitpick. |
Minor adjustments to the development environment documentation.