Skip to content

docs: fix typo and malformed .NET link in Windows installation guide#266

Open
Tanush576 wants to merge 3 commits intoOpenMS:developfrom
Tanush576:fix-windows-install-docs
Open

docs: fix typo and malformed .NET link in Windows installation guide#266
Tanush576 wants to merge 3 commits intoOpenMS:developfrom
Tanush576:fix-windows-install-docs

Conversation

@Tanush576
Copy link
Copy Markdown

@Tanush576 Tanush576 commented Mar 3, 2026

Describe the change

This PR fixes minor formatting and spelling errors in the Windows Installation "Known issues" section, addressing issue #265.

Changes made:

  • Corrected the typo "installion" to "installation".
  • Fixed the malformed markdown link for the Microsoft .NET 3.5 framework documentation and updated the URL to the current official Microsoft Learn page.

Fixes #265

Made with AI tools (Note: Used AI to assist with drafting the PR text and locating the updated Microsoft URL).

PR checklist

Summary by CodeRabbit

  • Documentation
    • Converted Windows top-level heading to an H1 and cleaned surrounding spacing for readability.
    • Standardized installer prompts and wording (e.g., changed “Run anyways” to “Run anyway”) and added a tip about installer behavior.
    • Normalized known-issues phrasing and quote spacing for error messages.
    • Updated external .NET guidance link to Microsoft Learn.
    • Fixed typos and improved overall formatting and line breaks.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b120dab4-5cc3-4a9b-ac98-8bb218581f4d

📥 Commits

Reviewing files that changed from the base of the PR and between d907b05 and 536e2a8.

📒 Files selected for processing (1)
  • docs/about/installation/installation-on-windows.md
✅ Files skipped from review due to trivial changes (1)
  • docs/about/installation/installation-on-windows.md

📝 Walkthrough

Walkthrough

This PR updates the Windows installation doc: converts the top-level Windows heading to H1, fixes typos and punctuation (e.g., "installion" → "installation", "Run anyways" → "Run anyway"), normalizes Known Issues formatting, replaces a malformed .NET link with the Microsoft Learn page, and adds a Windows installer tip block.

Changes

Cohort / File(s) Summary
Windows Installation Documentation
docs/about/installation/installation-on-windows.md
Converted top-level heading to H1; fixed typos and punctuation; adjusted Defender/run prompt wording ("Run anyway"); added a tip block about installer behavior; normalized Known Issues formatting and error-message quoting; replaced malformed .NET link with Microsoft Learn URL; general whitespace and formatting cleanup.

Poem

🐇 I hopped through docs with nimble paws,
Fixed a typo and mended flaws,
A .NET link now points aright,
Headings set to proper height,
Installer tip — hop, delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main changes: fixing a typo ('installion' to 'installation') and correcting a malformed .NET link in the Windows installation guide.
Linked Issues check ✅ Passed The PR addresses both primary objectives from issue #265: correcting the 'installion' typo and fixing the malformed .NET 3.5 documentation link with the proper Microsoft Learn URL.
Out of Scope Changes check ✅ Passed The changes are narrowly scoped to the Windows installation documentation as required. Additional formatting improvements and tip blocks appear to be complementary documentation enhancements closely related to the issue fixes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a 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

🤖 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/about/installation/installation-on-windows.md`:
- Around line 26-27: Fix the malformed quoted error message by removing the
stray apostrophe after SP1 and ensuring proper surrounding quotes; locate the
string "The installation of the Microsoft .NET 3.5 SP1' package failed!" in the
documentation and change it to a cleanly quoted message such as "The
installation of the Microsoft .NET 3.5 SP1 package failed!" so punctuation and
quoting are correct.
- Line 55: Change the unhyphenated phrase "third party tools (ProteoWizard)" to
the compound adjective form "third-party tools (ProteoWizard)" in the sentence
beginning "Fix is to enable the .NET Framework 3.5 yourself..." so the prose
uses the correct hyphenation for the compound modifier.
- Line 12: Replace the informal phrase in the user-facing sentence that reads
Click on "More Info", and then "Run anyways". in
docs/about/installation/installation-on-windows.md by changing "Run anyways" to
the standard form "Run anyway" so the sentence becomes Click on "More Info", and
then "Run anyway". Ensure only that wording is updated and punctuation remains
unchanged.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d412601 and 4e720f4.

📒 Files selected for processing (1)
  • docs/about/installation/installation-on-windows.md

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 `@docs/about/installation/installation-on-windows.md`:
- Line 29: The document uses inconsistent casing for ProteoWizard: change the
phrase "Third Party - Proteowizard" to "Third Party - ProteoWizard" (match the
usage on Line 55) so the product name is consistently capitalized; search for
occurrences of "Proteowizard" in this file and update them to "ProteoWizard" to
standardize casing.
- Line 55: The sentence "Fix is to enable the .NET Framework 3.5 yourself
through Control Panel..." that documents Known issue 4 is not indented and
renders outside the numbered item; update the Markdown so that this sentence is
a continuation of list item "4." by indenting that line by four spaces (or one
tab) so it is nested under the "4." list item (edit the paragraph containing the
.NET Framework 3.5 guidance in the Known issue 4 block).

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e720f4 and d907b05.

📒 Files selected for processing (1)
  • docs/about/installation/installation-on-windows.md

@Tanush576 Tanush576 force-pushed the fix-windows-install-docs branch from d907b05 to 32e3c57 Compare March 3, 2026 21:03
@Tanush576
Copy link
Copy Markdown
Author

Hi maintainers! Just a quick update: I have accepted and merged all of the coderabbitai bot's suggestions for grammar and punctuation into this PR.
I also wanted to give a heads-up regarding the build-sphinx CI check failure. I checked the logs, and it looks like the lychee link checker is throwing network errors (502/503) on a few external links in unrelated files (specifically in msstats.html and webapps.html).
My changes are strictly isolated to the typography and link fixes in the Windows Installation guide, so this PR should be fully ready for review whenever you have a moment. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Typo and malformed link in Windows Installation Known Issues

2 participants