-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Labels
bugSomething isn't workingSomething isn't working
Description
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:
- There is a typo in the first bullet point: the word "installion" is used instead of "installation".
- 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)
Expected behaviour
- The typo should be corrected to "installation".
- 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't working