Skip to content

Docs: Typo and malformed link in Windows Installation Known Issues #265

@Tanush576

Description

@Tanush576

Read Existing Documentation

I have checked the following places for the error:

Create OpenMS Bug Report

I have created the bug report in OpenMS for any pipeline errors.

Description of the documentation bug

  • I have attached screenshots of the incorrect documentation

While reading the Windows Installation guide (https://openms.readthedocs.io/en/latest/about/installation/installation-on-windows.html) under the "Known issues" section, I noticed two formatting and spelling errors:

  1. There is a typo in the first bullet point: the word "installion" is used instead of "installation".
  2. There is a malformed Markdown link in the fourth bullet point regarding the .NET framework: See this Microsoft help page.aspx#ControlPanel) for detailed information.

(Note: I will attach a screenshot of the errors below)

Image Image

Expected behaviour

  1. The typo should be corrected to "installation".
  2. The malformed link should be formatted correctly to point to the official Microsoft documentation (e.g., https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows).

OpenMS Installation

  • Version: 3.5.0

Additional context

I am currently exploring the project and preparing for GSoC 2026. I would love to submit a quick PR to fix these minor documentation errors to get familiar with the contribution workflow! Please let me know if I can go ahead and open a Pull Request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions