Open
Conversation
✅ Deploy Preview for openms ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughAdds governance documentation (Core Developers, Executive Committee, Governance), updates navbar and footer links to reference these pages, and updates contributor link to point to the Executive Committee page. Changes
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/governance.md`:
- Line 105: The heading "## 7. Relationship Between OpenMS Inc. and the OpenMS
Executive Committee" includes a stray "7." that should be removed to match other
unnumbered peer sections; update the heading text (the Markdown heading for
"Relationship Between OpenMS Inc. and the OpenMS Executive Committee") to "##
Relationship Between OpenMS Inc. and the OpenMS Executive Committee" so the
document and TOC render consistently.
- Around line 1-127: The governance page file must be relocated so the site
generator finds it: move the markdown currently at content/governance.md into
content/en/governance.md (matching the languages.en.contentDir setting in
config.yaml); after moving, verify any internal relative links or navigation
entries pointing to /governance still resolve and update them if necessary.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 823486d8-8ce7-487f-88ee-8e7ae18bc124
📒 Files selected for processing (2)
config.yamlcontent/governance.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
content/en/contributors.md (1)
14-14: Use descriptive link text instead of “here”.This reads fine, but generic anchor text is harder to scan and less accessible. Something like “see the [Executive Committee page]” would be clearer.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/en/contributors.md` at line 14, Replace the non-descriptive anchor text "[here]({{< relref \"/exec_committee\" >}})" with a descriptive label such as "[Executive Committee page]({{< relref \"/exec_committee\" >}})" (or "[Executive Committee]") so the link text clearly identifies the target; update the line containing the relref reference accordingly to improve clarity and accessibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@config.yaml`:
- Around line 157-158: The footer link "link: /core-developers" points to a URL
that doesn't match the new page filename core_developers; either add slug:
core-developers to the front matter of content/en/core_developers.md so Hugo
publishes it at /core-developers, or change the footer entry in config.yaml from
link: /core-developers to link: /core_developers so it matches the generated
URL; update whichever file you choose (the front matter in
content/en/core_developers.md or the footer block in config.yaml) and ensure
governance.md links remain consistent.
In `@content/en/exec_committee.md`:
- Around line 47-50: The phrase "by request of the member themself" under the
"Removal of Core Developers" heading reads awkwardly; replace "themself" with a
grammatically correct alternative such as "themselves" or simplify to "by
request of the member" so the sentence reads e.g. "or by request of the member
themselves" (or "or by request of the member") to improve clarity and tone.
---
Nitpick comments:
In `@content/en/contributors.md`:
- Line 14: Replace the non-descriptive anchor text "[here]({{< relref
\"/exec_committee\" >}})" with a descriptive label such as "[Executive Committee
page]({{< relref \"/exec_committee\" >}})" (or "[Executive Committee]") so the
link text clearly identifies the target; update the line containing the relref
reference accordingly to improve clarity and accessibility.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9d4c0393-4692-4a65-bd16-4b33e5ea7539
📒 Files selected for processing (5)
config.yamlcontent/en/contributors.mdcontent/en/core_developers.mdcontent/en/exec_committee.mdcontent/en/governance.md
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
content/en/onboarding.md (1)
55-55: Heading level skips from h1 to h3.Under the
# Communicationsection (line 49), subsections like### GitHub Issuesjump directly to h3, skipping h2. The same pattern occurs at line 104 under# Development Workflow. For proper semantic structure and accessibility, consider using##for these subsections.📝 Suggested fix for heading hierarchy
-### GitHub Issues +## GitHub IssuesApply the same change to
### GitHub Pull Requests,### Discord,### Project Meetings,### Reporting Issues,### Submitting Changes, and### Code Review.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/en/onboarding.md` at line 55, Several section headings under "# Communication" and "# Development Workflow" use "###" (h3) and skip h2; change those to "##" to restore proper heading hierarchy: update the headings titled "GitHub Issues", "GitHub Pull Requests", "Discord", "Project Meetings", "Reporting Issues", "Submitting Changes", and "Code Review" from "###" to "##" so they sit directly under their parent H1 sections and maintain semantic structure and accessibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@content/en/onboarding.md`:
- Line 55: Several section headings under "# Communication" and "# Development
Workflow" use "###" (h3) and skip h2; change those to "##" to restore proper
heading hierarchy: update the headings titled "GitHub Issues", "GitHub Pull
Requests", "Discord", "Project Meetings", "Reporting Issues", "Submitting
Changes", and "Code Review" from "###" to "##" so they sit directly under their
parent H1 sections and maintain semantic structure and accessibility.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f57a719f-3c73-4cbc-8916-eb5d2127b396
📒 Files selected for processing (3)
config.yamlcontent/en/exec_committee.mdcontent/en/onboarding.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add description of the interplay between OpenMS inc and the executive Committee.
Summary by CodeRabbit
New Features
Documentation