Add links to CONTRIBUTING and onboarding, align content with these.#267
Add links to CONTRIBUTING and onboarding, align content with these.#267
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated developer documentation: removed detailed Gitflow/forking and PR procedures, added explicit links to Contributor Onboarding Guide and canonical CONTRIBUTING.md, and clarified the guide focuses on technical implementation details for active developers. Changes
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/manual/develop.md (1)
15-15: Trim one of these two intro sentences.Line 15 and Line 33 are effectively saying the same thing, so keeping both feels redundant. I’d keep one and drop the other to make the page read cleaner.
Also applies to: 33-33
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manual/develop.md` at line 15, Remove the duplicated intro sentence: locate the sentence "This guide covers technical details for active developers." and the near-duplicate later in the document and delete one of them so only a single concise intro remains; ensure the remaining sentence reads naturally with the paragraph that follows and update surrounding whitespace/punctuation if needed.
🤖 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/manual/develop.md`:
- Around line 11-13: The new onboarding URL in docs/manual/develop.md
("Contributor Onboarding Guide" linking to https://openms.de/onboarding) points
to a page that doesn't yet exist; remove or replace that dead link: either
remove the hyperlink and keep plain text, or swap the href to an existing URL
(e.g., a current onboarding page or the repository's CONTRIBUTING.md) so the
"Contributor Onboarding Guide" link resolves; update the link text/URL in the
lines containing "Contributor Onboarding Guide" and
"https://openms.de/onboarding" accordingly.
---
Nitpick comments:
In `@docs/manual/develop.md`:
- Line 15: Remove the duplicated intro sentence: locate the sentence "This guide
covers technical details for active developers." and the near-duplicate later in
the document and delete one of them so only a single concise intro remains;
ensure the remaining sentence reads naturally with the paragraph that follows
and update surrounding whitespace/punctuation if needed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a1909538-a30e-4d0c-b10a-8171d8366434
📒 Files selected for processing (1)
docs/manual/develop.md
Updated link for the Contributor Onboarding Guide.
Merge after:
OpenMS/OpenMS-website#253
Summary by CodeRabbit