Update onboarding.md#30
Conversation
|
This pull request needs a small update before review:
|
📝 WalkthroughWalkthroughDocumentation updates to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 1/3 review remaining, refill in 37 minutes and 18 seconds. Comment |
github-actions
Bot
added
needs: title
github-actions
Bot
added
the
needs: title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/onboarding.md`:
- Around line 175-176: The sentence "See docs/onboarding.md for full example
outputs." is a self-referential link and should point to a concrete examples
location; replace that text with a link to a concrete section anchor in the same
document (for example use an anchor like "#example-outputs" and text "See the
Example outputs section") or change it to point to a dedicated examples document
(e.g., an onboarding examples page) and update the link text accordingly so
readers are taken directly to the example outputs instead of the current file.
- Around line 170-174: Replace the repo-global verification command "nexgit
version --json" with the repo-local invocation "cargo run -p nexgit-cli --
version --json" so first-time contributors who haven't installed nexgit on PATH
can run the check; update the onboarding text to show the cargo run form (or
alternatively add an explicit install step) and ensure the example matches the
earlier guidance that uses cargo run for nexgit CLI.
- Around line 178-188: Remove the PR-template/process block titled "⚠️ IMPORTANT
(DO NOT MISS)" and the mandatory phrase “scaffold / placeholder output” from the
onboarding document; instead relocate that content to the PR template or
reviewer checklist (or delete if not needed). Locate the block by searching for
the header text "⚠️ IMPORTANT (DO NOT MISS)" and the exact phrase "scaffold /
placeholder output" in the onboarding content, then delete the entire admonition
section so the onboarding.md only contains contributor-facing onboarding
guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| You can verify your setup using scaffold commands: | ||
|
|
||
| ```bash | ||
| nexgit version --json | ||
|
|
There was a problem hiding this comment.
Use a repo-local command for setup verification.
nexgit version --json can fail for first-time contributors if nexgit is not installed on PATH. This doc currently teaches cargo run -p nexgit-cli -- ..., so verification should follow that pattern (or add an explicit install step first).
Suggested doc fix
-You can verify your setup using scaffold commands:
+You can verify your setup with a repo-local command:
```bash
-nexgit version --json
+cargo run -p nexgit-cli -- version --json</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @docs/onboarding.md around lines 170 - 174, Replace the repo-global
verification command "nexgit version --json" with the repo-local invocation
"cargo run -p nexgit-cli -- version --json" so first-time contributors who
haven't installed nexgit on PATH can run the check; update the onboarding text
to show the cargo run form (or alternatively add an explicit install step) and
ensure the example matches the earlier guidance that uses cargo run for nexgit
CLI.
</details>
<!-- fingerprinting:phantom:triton:hawk:e7228453-4bb5-4795-b0df-93d064734269 -->
<!-- d98c2f50 -->
<!-- This is an auto-generated comment by CodeRabbit -->
| See docs/onboarding.md for full example outputs. | ||
|
|
There was a problem hiding this comment.
Fix the self-referential documentation link.
This points to the same file, so it doesn’t help readers find examples. Link to a concrete section anchor or a separate examples file.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/onboarding.md` around lines 175 - 176, The sentence "See
docs/onboarding.md for full example outputs." is a self-referential link and
should point to a concrete examples location; replace that text with a link to a
concrete section anchor in the same document (for example use an anchor like
"#example-outputs" and text "See the Example outputs section") or change it to
point to a dedicated examples document (e.g., an onboarding examples page) and
update the link text accordingly so readers are taken directly to the example
outputs instead of the current file.
| --- | ||
|
|
||
| # ⚠️ IMPORTANT (DO NOT MISS) | ||
|
|
||
| You MUST clearly mention: | ||
|
|
||
| 👉 “**scaffold / placeholder output**” | ||
|
|
||
| This is part of acceptance criteria. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Remove PR-template/process text from onboarding docs.
The “IMPORTANT (DO NOT MISS)” block and mandatory phrase requirement look like review/acceptance instructions, not contributor onboarding content. This should be removed from this doc (or moved to PR template/reviewer checklist docs).
Suggested doc cleanup
----
-
-# ⚠️ IMPORTANT (DO NOT MISS)
-
-You MUST clearly mention:
-
-👉 “**scaffold / placeholder output**”
-
-This is part of acceptance criteria.
-
----🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/onboarding.md` around lines 178 - 188, Remove the PR-template/process
block titled "⚠️ IMPORTANT (DO NOT MISS)" and the mandatory phrase “scaffold /
placeholder output” from the onboarding document; instead relocate that content
to the PR template or reviewer checklist (or delete if not needed). Locate the
block by searching for the header text "⚠️ IMPORTANT (DO NOT MISS)" and the
exact phrase "scaffold / placeholder output" in the onboarding content, then
delete the entire admonition section so the onboarding.md only contains
contributor-facing onboarding guidance.
2 participants
Pull Request
Summary
Describe the change and the user or maintainer outcome.
Linked context
Closes # or Related to # or Supersedes #
Checklist
Notes for reviewers
Call out any tradeoffs, follow-up work, or setup needed to validate the change.
Summary by CodeRabbit