Skip to content

Update onboarding.md #30

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.

Sign up for GitHub

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

Closed
Ashusf90 wants to merge 1 commit into from
Closed

Update onboarding.md #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,23 @@ Try these steps:
4. Ask for help with context.

Getting stuck is part of contributing. Please ask questions.

You can verify your setup using scaffold commands:

```bash
nexgit version --json

Comment on lines +170 to +174
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

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.

Comment on lines +175 to +176
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

---
Comment on lines +178 to +188
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

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.

Loading